Anonymitaet commented on code in PR #399: URL: https://github.com/apache/pulsar-site/pull/399#discussion_r1106571571
########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. Review Comment: ```suggestion This tutorial uses Apache Pulsar 2.9.3 as an example. If you want to upgrade Pulsar version, follow the instructions in [Helm Upgrade Guide](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/). ``` Do you intend to mean this? ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + Review Comment: ```suggestion Deploying a Pulsar cluster on IBM cloud consists of the following steps: ``` ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note Review Comment: ```suggestion :::tip ``` It's a tip rather than note. ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart Review Comment: ```suggestion ``` Line 3 already shows the title ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. Review Comment: ```suggestion ## Step 3: Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. ``` ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud Review Comment: This title should be consistent with line 17 because they talk about the same thing. ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. + +**Requirements** : +- Installation of [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli): For login in IBM cloud and for connection to Kubernetes master node. + +- Installation of [IBM Cloud CLI Plugins](https://cloud.ibm.com/docs/containers?topic=containers-cs_cli_install) Required for connect to IKS (IBM Kubernetes services). + +- Installation of [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) (kubeControl-CLI) version 1.23, because on IBM we are using kubernetes version 1.23 +- Installation of [Helm](https://helm.sh/docs/intro/install/) Review Comment: ```suggestion - Install [Helm](https://helm.sh/docs/intro/install/). ``` ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. + +**Requirements** : +- Installation of [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli): For login in IBM cloud and for connection to Kubernetes master node. + +- Installation of [IBM Cloud CLI Plugins](https://cloud.ibm.com/docs/containers?topic=containers-cs_cli_install) Required for connect to IKS (IBM Kubernetes services). + +- Installation of [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) (kubeControl-CLI) version 1.23, because on IBM we are using kubernetes version 1.23 +- Installation of [Helm](https://helm.sh/docs/intro/install/) + +> Note:- Please install all the above things before running the below commands + +- First take SSH of your VM with your private key. Run all the below commands one by one. +```bash + $ ibmcloud login + $ ibmcloud plugin list +``` + +Output + + +- For connection to Kubernetes cluster, you will get command in Kubernete cluster section. It is like below example. + +> Note: below command is just an example, you will get this command in your kubernetes console. + +```bash + $ibmcloud ks cluster config --cluster ccql163t064kpvg5gg10 +``` + +> Note: this step is showing during creation of Kubernetes Cluster. + + + +- After running 2nd and 3rd commands showing in above image you will get output shows like in the below image (no need to run number 1 command because we already logged in to IBM Cloud) Review Comment: ```suggestion - After running the second and third commands shown in the above images, you will get an output as below. You do not need to run the first command because you've already logged in to IBM Cloud. ``` ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. + +**Requirements** : +- Installation of [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli): For login in IBM cloud and for connection to Kubernetes master node. + +- Installation of [IBM Cloud CLI Plugins](https://cloud.ibm.com/docs/containers?topic=containers-cs_cli_install) Required for connect to IKS (IBM Kubernetes services). + +- Installation of [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) (kubeControl-CLI) version 1.23, because on IBM we are using kubernetes version 1.23 +- Installation of [Helm](https://helm.sh/docs/intro/install/) + +> Note:- Please install all the above things before running the below commands + +- First take SSH of your VM with your private key. Run all the below commands one by one. +```bash + $ ibmcloud login + $ ibmcloud plugin list +``` + +Output + + +- For connection to Kubernetes cluster, you will get command in Kubernete cluster section. It is like below example. + +> Note: below command is just an example, you will get this command in your kubernetes console. Review Comment: Consolidate line 142 to line 140. `Note` is not needed here. ```suggestion ``` ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. + +**Requirements** : +- Installation of [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli): For login in IBM cloud and for connection to Kubernetes master node. + +- Installation of [IBM Cloud CLI Plugins](https://cloud.ibm.com/docs/containers?topic=containers-cs_cli_install) Required for connect to IKS (IBM Kubernetes services). + +- Installation of [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) (kubeControl-CLI) version 1.23, because on IBM we are using kubernetes version 1.23 +- Installation of [Helm](https://helm.sh/docs/intro/install/) + +> Note:- Please install all the above things before running the below commands + +- First take SSH of your VM with your private key. Run all the below commands one by one. +```bash + $ ibmcloud login + $ ibmcloud plugin list +``` + +Output + + +- For connection to Kubernetes cluster, you will get command in Kubernete cluster section. It is like below example. + +> Note: below command is just an example, you will get this command in your kubernetes console. + +```bash + $ibmcloud ks cluster config --cluster ccql163t064kpvg5gg10 +``` + +> Note: this step is showing during creation of Kubernetes Cluster. + + + +- After running 2nd and 3rd commands showing in above image you will get output shows like in the below image (no need to run number 1 command because we already logged in to IBM Cloud) + +Output + + +> Now we are able to run commands of kubectl. + +#### Run kubectl commands to verify the deployment +Make sure all the pods of Pulsar are runnig. Get the service URL and broker URL for publishing and consuming the messages. + + +- We will add "Pulsar" Helm repo in VM and clone the repo of Apache Pulsar from Github, below is all the commands. + +> [Installation of Pulsar helm in minikube cluster](https://pulsar.apache.org/docs/getting-started-helm/) this document is for minikube cluster we are taking reference from that. + +1. Add Pulsar chart repo + +```bash +$ helm repo add apache https://pulsar.apache.org/charts +$ helm repo update +$ helm repo list +``` + +Output + + +2. Clone the Pulsar Helm chart repository, go inside the pulsar-helm-chart directory + +```bash +git clone https://github.com/apache/pulsar-helm-chart +cd pulsar-helm-chart +``` + +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 -n default -k asia -c +``` + +Output + + +4. Use the Pulsar Helm chart to install a Pulsar cluster to Kubernetes. + +```bash +helm install --values examples/values-minikube.yaml --set initialize=true asia apache/pulsar +``` + +:::note + +You need to specify`--set initialize=true`when installing Pulsar the first time. This command installs and starts Apache Pulsar. + +::: Review Comment: Do not repeat the content in https://pulsar.apache.org/docs/2.11.x/getting-started-helm/. If you want to reuse them, just insert the link and highlight the difference (if any). For example, 1. [Install Pulsar Helm in minikube cluster](link-to-exsiting-doc]. ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. + +**Requirements** : +- Installation of [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli): For login in IBM cloud and for connection to Kubernetes master node. + +- Installation of [IBM Cloud CLI Plugins](https://cloud.ibm.com/docs/containers?topic=containers-cs_cli_install) Required for connect to IKS (IBM Kubernetes services). + +- Installation of [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) (kubeControl-CLI) version 1.23, because on IBM we are using kubernetes version 1.23 +- Installation of [Helm](https://helm.sh/docs/intro/install/) + +> Note:- Please install all the above things before running the below commands + +- First take SSH of your VM with your private key. Run all the below commands one by one. +```bash + $ ibmcloud login + $ ibmcloud plugin list +``` + +Output + + +- For connection to Kubernetes cluster, you will get command in Kubernete cluster section. It is like below example. + +> Note: below command is just an example, you will get this command in your kubernetes console. + +```bash + $ibmcloud ks cluster config --cluster ccql163t064kpvg5gg10 +``` + +> Note: this step is showing during creation of Kubernetes Cluster. + + + +- After running 2nd and 3rd commands showing in above image you will get output shows like in the below image (no need to run number 1 command because we already logged in to IBM Cloud) + +Output + + +> Now we are able to run commands of kubectl. + +#### Run kubectl commands to verify the deployment Review Comment: ```suggestion ## Verify the deployment ``` This should be consistent with line 20. Titles should be concise and simple. ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. + +**Requirements** : +- Installation of [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli): For login in IBM cloud and for connection to Kubernetes master node. + +- Installation of [IBM Cloud CLI Plugins](https://cloud.ibm.com/docs/containers?topic=containers-cs_cli_install) Required for connect to IKS (IBM Kubernetes services). + +- Installation of [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) (kubeControl-CLI) version 1.23, because on IBM we are using kubernetes version 1.23 +- Installation of [Helm](https://helm.sh/docs/intro/install/) + +> Note:- Please install all the above things before running the below commands + +- First take SSH of your VM with your private key. Run all the below commands one by one. +```bash + $ ibmcloud login + $ ibmcloud plugin list +``` + +Output + + +- For connection to Kubernetes cluster, you will get command in Kubernete cluster section. It is like below example. + +> Note: below command is just an example, you will get this command in your kubernetes console. + +```bash + $ibmcloud ks cluster config --cluster ccql163t064kpvg5gg10 +``` + +> Note: this step is showing during creation of Kubernetes Cluster. + + + +- After running 2nd and 3rd commands showing in above image you will get output shows like in the below image (no need to run number 1 command because we already logged in to IBM Cloud) + +Output + + +> Now we are able to run commands of kubectl. + +#### Run kubectl commands to verify the deployment +Make sure all the pods of Pulsar are runnig. Get the service URL and broker URL for publishing and consuming the messages. Review Comment: ```suggestion Make sure all the pods of Pulsar are running. Get the service URL and broker URL for publishing and consuming the messages. ``` ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) Review Comment: ```suggestion 1. [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) 2. [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) 3. [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) 4. [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) ``` ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. + +**Requirements** : Review Comment: ```suggestion **Prerequisites** ``` ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. Review Comment: 1. From line 25 - 157, please use ordered lists instead of unordered lists to indicate the sequence. 2. Line 25 - 117 has not been reviewed because ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. + +**Requirements** : +- Installation of [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli): For login in IBM cloud and for connection to Kubernetes master node. Review Comment: ```suggestion - Install [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli) and connect to Kubernetes master node. ``` ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. + +**Requirements** : +- Installation of [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli): For login in IBM cloud and for connection to Kubernetes master node. + +- Installation of [IBM Cloud CLI Plugins](https://cloud.ibm.com/docs/containers?topic=containers-cs_cli_install) Required for connect to IKS (IBM Kubernetes services). + +- Installation of [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) (kubeControl-CLI) version 1.23, because on IBM we are using kubernetes version 1.23 Review Comment: ```suggestion - Install [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) 1.23 or later versions. ``` Here should list "general" requirements. If we have no idea about this, we can change this to "This tutorial installs [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) 1.23 as an example". ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. + +**Requirements** : +- Installation of [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli): For login in IBM cloud and for connection to Kubernetes master node. + +- Installation of [IBM Cloud CLI Plugins](https://cloud.ibm.com/docs/containers?topic=containers-cs_cli_install) Required for connect to IKS (IBM Kubernetes services). Review Comment: ```suggestion - Install [IBM Cloud CLI Plugins](https://cloud.ibm.com/docs/containers?topic=containers-cs_cli_install) to connect to IKS (IBM Kubernetes services). This is a required step. ``` ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. + +**Requirements** : +- Installation of [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli): For login in IBM cloud and for connection to Kubernetes master node. + +- Installation of [IBM Cloud CLI Plugins](https://cloud.ibm.com/docs/containers?topic=containers-cs_cli_install) Required for connect to IKS (IBM Kubernetes services). + +- Installation of [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) (kubeControl-CLI) version 1.23, because on IBM we are using kubernetes version 1.23 +- Installation of [Helm](https://helm.sh/docs/intro/install/) + +> Note:- Please install all the above things before running the below commands + +- First take SSH of your VM with your private key. Run all the below commands one by one. +```bash + $ ibmcloud login + $ ibmcloud plugin list +``` + +Output + + +- For connection to Kubernetes cluster, you will get command in Kubernete cluster section. It is like below example. + +> Note: below command is just an example, you will get this command in your kubernetes console. + +```bash + $ibmcloud ks cluster config --cluster ccql163t064kpvg5gg10 +``` + +> Note: this step is showing during creation of Kubernetes Cluster. + + + +- After running 2nd and 3rd commands showing in above image you will get output shows like in the below image (no need to run number 1 command because we already logged in to IBM Cloud) + +Output + + +> Now we are able to run commands of kubectl. + +#### Run kubectl commands to verify the deployment +Make sure all the pods of Pulsar are runnig. Get the service URL and broker URL for publishing and consuming the messages. + + +- We will add "Pulsar" Helm repo in VM and clone the repo of Apache Pulsar from Github, below is all the commands. + +> [Installation of Pulsar helm in minikube cluster](https://pulsar.apache.org/docs/getting-started-helm/) this document is for minikube cluster we are taking reference from that. + +1. Add Pulsar chart repo + +```bash +$ helm repo add apache https://pulsar.apache.org/charts +$ helm repo update +$ helm repo list +``` + +Output + + +2. Clone the Pulsar Helm chart repository, go inside the pulsar-helm-chart directory + +```bash +git clone https://github.com/apache/pulsar-helm-chart +cd pulsar-helm-chart +``` + +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 -n default -k asia -c +``` + +Output + + +4. Use the Pulsar Helm chart to install a Pulsar cluster to Kubernetes. + +```bash +helm install --values examples/values-minikube.yaml --set initialize=true asia apache/pulsar +``` + +:::note + +You need to specify`--set initialize=true`when installing Pulsar the first time. This command installs and starts Apache Pulsar. + +::: + +Output + + +5. Check the status of all pods. + +```bash +kubectl get pods +``` +If all pods start up successfully, you can see that the`STATUS`is changed to`Running`or`Completed` + +Output + + +6. Check the status of all services + +```bash + kubectl get services +``` + +Output + + +> Output of above command will give us `services URL` and `broker URL`, proxy external ip is for both just change ports (for service URL port is 80 and for broker URL port is 6650 this is default) +If all of these commands are successful, Pulsar clients can now use your cluster! + +> You can use Pulsar client to publishing and consuming messages you just need to use `proxy external IP` and ports of `broker URL` and `service URL`. Review Comment: Suggest adding a simple example of producing and consuming messages here. In this way, it's a complete tutorial. ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. + +**Requirements** : +- Installation of [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli): For login in IBM cloud and for connection to Kubernetes master node. + +- Installation of [IBM Cloud CLI Plugins](https://cloud.ibm.com/docs/containers?topic=containers-cs_cli_install) Required for connect to IKS (IBM Kubernetes services). + +- Installation of [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) (kubeControl-CLI) version 1.23, because on IBM we are using kubernetes version 1.23 +- Installation of [Helm](https://helm.sh/docs/intro/install/) + +> Note:- Please install all the above things before running the below commands + +- First take SSH of your VM with your private key. Run all the below commands one by one. +```bash + $ ibmcloud login + $ ibmcloud plugin list +``` + +Output + + +- For connection to Kubernetes cluster, you will get command in Kubernete cluster section. It is like below example. Review Comment: ```suggestion - For connection to the Kubernetes cluster, you will get a command in the Kubernetes cluster section (Kubernetes console) as below. ``` ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. + +**Requirements** : +- Installation of [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli): For login in IBM cloud and for connection to Kubernetes master node. + +- Installation of [IBM Cloud CLI Plugins](https://cloud.ibm.com/docs/containers?topic=containers-cs_cli_install) Required for connect to IKS (IBM Kubernetes services). + +- Installation of [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) (kubeControl-CLI) version 1.23, because on IBM we are using kubernetes version 1.23 +- Installation of [Helm](https://helm.sh/docs/intro/install/) + +> Note:- Please install all the above things before running the below commands Review Comment: ::: note xxx ::: ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. + +**Requirements** : +- Installation of [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli): For login in IBM cloud and for connection to Kubernetes master node. + +- Installation of [IBM Cloud CLI Plugins](https://cloud.ibm.com/docs/containers?topic=containers-cs_cli_install) Required for connect to IKS (IBM Kubernetes services). + +- Installation of [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) (kubeControl-CLI) version 1.23, because on IBM we are using kubernetes version 1.23 +- Installation of [Helm](https://helm.sh/docs/intro/install/) + +> Note:- Please install all the above things before running the below commands + +- First take SSH of your VM with your private key. Run all the below commands one by one. +```bash + $ ibmcloud login + $ ibmcloud plugin list +``` + +Output + + +- For connection to Kubernetes cluster, you will get command in Kubernete cluster section. It is like below example. + +> Note: below command is just an example, you will get this command in your kubernetes console. + +```bash + $ibmcloud ks cluster config --cluster ccql163t064kpvg5gg10 +``` + +> Note: this step is showing during creation of Kubernetes Cluster. + + + +- After running 2nd and 3rd commands showing in above image you will get output shows like in the below image (no need to run number 1 command because we already logged in to IBM Cloud) + +Output + + +> Now we are able to run commands of kubectl. + +#### Run kubectl commands to verify the deployment +Make sure all the pods of Pulsar are runnig. Get the service URL and broker URL for publishing and consuming the messages. + + +- We will add "Pulsar" Helm repo in VM and clone the repo of Apache Pulsar from Github, below is all the commands. Review Comment: ```suggestion ``` Suggest removing this because: 1. The steps below have already explained. 2. If the steps are long, suggest adding a simple summary like ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. + +**Requirements** : +- Installation of [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli): For login in IBM cloud and for connection to Kubernetes master node. + +- Installation of [IBM Cloud CLI Plugins](https://cloud.ibm.com/docs/containers?topic=containers-cs_cli_install) Required for connect to IKS (IBM Kubernetes services). + +- Installation of [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) (kubeControl-CLI) version 1.23, because on IBM we are using kubernetes version 1.23 +- Installation of [Helm](https://helm.sh/docs/intro/install/) + +> Note:- Please install all the above things before running the below commands + +- First take SSH of your VM with your private key. Run all the below commands one by one. +```bash + $ ibmcloud login + $ ibmcloud plugin list +``` + +Output + + +- For connection to Kubernetes cluster, you will get command in Kubernete cluster section. It is like below example. + +> Note: below command is just an example, you will get this command in your kubernetes console. + +```bash + $ibmcloud ks cluster config --cluster ccql163t064kpvg5gg10 +``` + +> Note: this step is showing during creation of Kubernetes Cluster. + + + +- After running 2nd and 3rd commands showing in above image you will get output shows like in the below image (no need to run number 1 command because we already logged in to IBM Cloud) + +Output + + +> Now we are able to run commands of kubectl. + +#### Run kubectl commands to verify the deployment +Make sure all the pods of Pulsar are runnig. Get the service URL and broker URL for publishing and consuming the messages. + + +- We will add "Pulsar" Helm repo in VM and clone the repo of Apache Pulsar from Github, below is all the commands. + +> [Installation of Pulsar helm in minikube cluster](https://pulsar.apache.org/docs/getting-started-helm/) this document is for minikube cluster we are taking reference from that. + +1. Add Pulsar chart repo + +```bash +$ helm repo add apache https://pulsar.apache.org/charts +$ helm repo update +$ helm repo list +``` + +Output + + +2. Clone the Pulsar Helm chart repository, go inside the pulsar-helm-chart directory + +```bash +git clone https://github.com/apache/pulsar-helm-chart +cd pulsar-helm-chart +``` + +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 -n default -k asia -c +``` + +Output + + +4. Use the Pulsar Helm chart to install a Pulsar cluster to Kubernetes. + +```bash +helm install --values examples/values-minikube.yaml --set initialize=true asia apache/pulsar +``` + +:::note + +You need to specify`--set initialize=true`when installing Pulsar the first time. This command installs and starts Apache Pulsar. + +::: + +Output + + +5. Check the status of all pods. + +```bash +kubectl get pods +``` +If all pods start up successfully, you can see that the`STATUS`is changed to`Running`or`Completed` + +Output + + +6. Check the status of all services Review Comment: ```suggestion 6. Check the status of all services. ``` ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. + +**Requirements** : +- Installation of [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli): For login in IBM cloud and for connection to Kubernetes master node. + +- Installation of [IBM Cloud CLI Plugins](https://cloud.ibm.com/docs/containers?topic=containers-cs_cli_install) Required for connect to IKS (IBM Kubernetes services). + +- Installation of [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) (kubeControl-CLI) version 1.23, because on IBM we are using kubernetes version 1.23 +- Installation of [Helm](https://helm.sh/docs/intro/install/) + +> Note:- Please install all the above things before running the below commands + +- First take SSH of your VM with your private key. Run all the below commands one by one. +```bash + $ ibmcloud login + $ ibmcloud plugin list +``` + +Output + + +- For connection to Kubernetes cluster, you will get command in Kubernete cluster section. It is like below example. + +> Note: below command is just an example, you will get this command in your kubernetes console. + +```bash + $ibmcloud ks cluster config --cluster ccql163t064kpvg5gg10 +``` + +> Note: this step is showing during creation of Kubernetes Cluster. + + + +- After running 2nd and 3rd commands showing in above image you will get output shows like in the below image (no need to run number 1 command because we already logged in to IBM Cloud) + +Output + + +> Now we are able to run commands of kubectl. + +#### Run kubectl commands to verify the deployment +Make sure all the pods of Pulsar are runnig. Get the service URL and broker URL for publishing and consuming the messages. + + +- We will add "Pulsar" Helm repo in VM and clone the repo of Apache Pulsar from Github, below is all the commands. + +> [Installation of Pulsar helm in minikube cluster](https://pulsar.apache.org/docs/getting-started-helm/) this document is for minikube cluster we are taking reference from that. + +1. Add Pulsar chart repo + +```bash +$ helm repo add apache https://pulsar.apache.org/charts +$ helm repo update +$ helm repo list +``` + +Output + + +2. Clone the Pulsar Helm chart repository, go inside the pulsar-helm-chart directory + +```bash +git clone https://github.com/apache/pulsar-helm-chart +cd pulsar-helm-chart +``` + +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 -n default -k asia -c +``` + +Output + + +4. Use the Pulsar Helm chart to install a Pulsar cluster to Kubernetes. + +```bash +helm install --values examples/values-minikube.yaml --set initialize=true asia apache/pulsar +``` + +:::note + +You need to specify`--set initialize=true`when installing Pulsar the first time. This command installs and starts Apache Pulsar. + +::: + +Output + + +5. Check the status of all pods. + +```bash +kubectl get pods +``` +If all pods start up successfully, you can see that the`STATUS`is changed to`Running`or`Completed` Review Comment: ```suggestion If all pods start up successfully, you can see that `STATUS`is changed to`Running`or`Completed`. ``` ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. + +**Requirements** : +- Installation of [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli): For login in IBM cloud and for connection to Kubernetes master node. + +- Installation of [IBM Cloud CLI Plugins](https://cloud.ibm.com/docs/containers?topic=containers-cs_cli_install) Required for connect to IKS (IBM Kubernetes services). + +- Installation of [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) (kubeControl-CLI) version 1.23, because on IBM we are using kubernetes version 1.23 +- Installation of [Helm](https://helm.sh/docs/intro/install/) + +> Note:- Please install all the above things before running the below commands + +- First take SSH of your VM with your private key. Run all the below commands one by one. +```bash + $ ibmcloud login + $ ibmcloud plugin list +``` + +Output + + +- For connection to Kubernetes cluster, you will get command in Kubernete cluster section. It is like below example. + +> Note: below command is just an example, you will get this command in your kubernetes console. + +```bash + $ibmcloud ks cluster config --cluster ccql163t064kpvg5gg10 +``` + +> Note: this step is showing during creation of Kubernetes Cluster. + + + +- After running 2nd and 3rd commands showing in above image you will get output shows like in the below image (no need to run number 1 command because we already logged in to IBM Cloud) + +Output + + +> Now we are able to run commands of kubectl. + +#### Run kubectl commands to verify the deployment +Make sure all the pods of Pulsar are runnig. Get the service URL and broker URL for publishing and consuming the messages. + + +- We will add "Pulsar" Helm repo in VM and clone the repo of Apache Pulsar from Github, below is all the commands. + +> [Installation of Pulsar helm in minikube cluster](https://pulsar.apache.org/docs/getting-started-helm/) this document is for minikube cluster we are taking reference from that. + +1. Add Pulsar chart repo + +```bash +$ helm repo add apache https://pulsar.apache.org/charts +$ helm repo update +$ helm repo list +``` + +Output + + +2. Clone the Pulsar Helm chart repository, go inside the pulsar-helm-chart directory + +```bash +git clone https://github.com/apache/pulsar-helm-chart +cd pulsar-helm-chart +``` + +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 -n default -k asia -c +``` + +Output + + +4. Use the Pulsar Helm chart to install a Pulsar cluster to Kubernetes. + +```bash +helm install --values examples/values-minikube.yaml --set initialize=true asia apache/pulsar +``` + +:::note + +You need to specify`--set initialize=true`when installing Pulsar the first time. This command installs and starts Apache Pulsar. + +::: + +Output + + +5. Check the status of all pods. + +```bash +kubectl get pods +``` +If all pods start up successfully, you can see that the`STATUS`is changed to`Running`or`Completed` + +Output + + +6. Check the status of all services + +```bash + kubectl get services +``` + +Output + + +> Output of above command will give us `services URL` and `broker URL`, proxy external ip is for both just change ports (for service URL port is 80 and for broker URL port is 6650 this is default) Review Comment: ```suggestion The output shows both `services URL` and `broker URL`. Proxy external IPs are the ports changed just now: - Service URL port is 80. - Broker URL port is 6650. This is default. ``` ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. + +**Requirements** : +- Installation of [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli): For login in IBM cloud and for connection to Kubernetes master node. + +- Installation of [IBM Cloud CLI Plugins](https://cloud.ibm.com/docs/containers?topic=containers-cs_cli_install) Required for connect to IKS (IBM Kubernetes services). + +- Installation of [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) (kubeControl-CLI) version 1.23, because on IBM we are using kubernetes version 1.23 +- Installation of [Helm](https://helm.sh/docs/intro/install/) + +> Note:- Please install all the above things before running the below commands + +- First take SSH of your VM with your private key. Run all the below commands one by one. +```bash + $ ibmcloud login + $ ibmcloud plugin list +``` + +Output + + +- For connection to Kubernetes cluster, you will get command in Kubernete cluster section. It is like below example. + +> Note: below command is just an example, you will get this command in your kubernetes console. + +```bash + $ibmcloud ks cluster config --cluster ccql163t064kpvg5gg10 +``` + +> Note: this step is showing during creation of Kubernetes Cluster. + + + +- After running 2nd and 3rd commands showing in above image you will get output shows like in the below image (no need to run number 1 command because we already logged in to IBM Cloud) + +Output + + +> Now we are able to run commands of kubectl. + +#### Run kubectl commands to verify the deployment +Make sure all the pods of Pulsar are runnig. Get the service URL and broker URL for publishing and consuming the messages. + + +- We will add "Pulsar" Helm repo in VM and clone the repo of Apache Pulsar from Github, below is all the commands. + +> [Installation of Pulsar helm in minikube cluster](https://pulsar.apache.org/docs/getting-started-helm/) this document is for minikube cluster we are taking reference from that. + +1. Add Pulsar chart repo + +```bash +$ helm repo add apache https://pulsar.apache.org/charts +$ helm repo update +$ helm repo list +``` + +Output + + +2. Clone the Pulsar Helm chart repository, go inside the pulsar-helm-chart directory + +```bash +git clone https://github.com/apache/pulsar-helm-chart +cd pulsar-helm-chart +``` + +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 -n default -k asia -c +``` + +Output + + +4. Use the Pulsar Helm chart to install a Pulsar cluster to Kubernetes. + +```bash +helm install --values examples/values-minikube.yaml --set initialize=true asia apache/pulsar +``` + +:::note + +You need to specify`--set initialize=true`when installing Pulsar the first time. This command installs and starts Apache Pulsar. + +::: + +Output + + +5. Check the status of all pods. + +```bash +kubectl get pods +``` +If all pods start up successfully, you can see that the`STATUS`is changed to`Running`or`Completed` + +Output + + +6. Check the status of all services + +```bash + kubectl get services +``` + +Output + + +> Output of above command will give us `services URL` and `broker URL`, proxy external ip is for both just change ports (for service URL port is 80 and for broker URL port is 6650 this is default) +If all of these commands are successful, Pulsar clients can now use your cluster! + +> You can use Pulsar client to publishing and consuming messages you just need to use `proxy external IP` and ports of `broker URL` and `service URL`. Review Comment: ```suggestion ``` Consolidate this to line 235 ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) Review Comment: Suggest taking another way to write this part. For example, move Step 1 and Step 2 to another tutorial and insert the link of that tutorial here. Reason: Step 1 and Step 2 are loosely related to Pulsar, which should be regarded as an independent topic (tutorial). We should only include Pulsar-relevant content in Pulsar docs, or else the page is too long, which decreases the readability. ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) + + +#### Create VM on IBM Cloud + +- Go to [IBM Cloud]( https://cloud.ibm.com/login) and login with your credentials. +- Search for Virtual Server. +- Select Virtual Server for Classic. + + + +- Select the type of virtual server as selected "Public" in the image. +- Type the host name, quantity of the machine and billing method. + + + +- Select location value according to your region. For example: In below image we have selected Chennai in Asia region. + + + +- Select the profile of virtual machine. + + + +- Select the operating system and version. + + + +- Select network interface according to use. + + + +- Select the security group. + + + +- Leave rest of the things could be default. Click on the "Create" button. + + + +- Check created VM in "Navigation Menu" -> "Resource list" Devices + + + + + +- Check the detail of VM in overview + + + +- Check the devices list, click on the menu option on the same page. + + + +#### Create Kubernetes Cluster on IBM + +- Search for the Kubernetes services + + + +- Select the plan details to "Standard". Please note "Free" plan has the limited resources, which can not fulfill the Pulsar cluster requirement. + + + +- Select the infrastructure type we are going with the classic and also select the Kubernetes version . + + + +- Select location and resource group. Select single single zone or multi zone as per your need. + + + + + +- Select worker pool size and flavor (vCPU, Memory) of the worker. + + + + + +- Set cluster name as you want. + + +- Leave rest of the things as we are selecting as default. You can disable below options. Click on create and wait for provisioning of the cluster. + + + +- After the cluster is successfully provisioned, connect to the cluster. In order to connect click on the "Action" button then click on "Connect via CLI", it will give you commands, copy that and run in your VM so that we can communicate to cluster through VM. We have to configure VM for communicating to cluster in the next steps will describe how to configure VM for that. + + + +- Check the created cluster list through clicking on the clusters options + + + +- It will show you the list of all the created clusters. + + + +#### Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster. + +**Requirements** : +- Installation of [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli): For login in IBM cloud and for connection to Kubernetes master node. + +- Installation of [IBM Cloud CLI Plugins](https://cloud.ibm.com/docs/containers?topic=containers-cs_cli_install) Required for connect to IKS (IBM Kubernetes services). + +- Installation of [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) (kubeControl-CLI) version 1.23, because on IBM we are using kubernetes version 1.23 +- Installation of [Helm](https://helm.sh/docs/intro/install/) + +> Note:- Please install all the above things before running the below commands + +- First take SSH of your VM with your private key. Run all the below commands one by one. +```bash + $ ibmcloud login + $ ibmcloud plugin list +``` + +Output + + +- For connection to Kubernetes cluster, you will get command in Kubernete cluster section. It is like below example. + +> Note: below command is just an example, you will get this command in your kubernetes console. + +```bash + $ibmcloud ks cluster config --cluster ccql163t064kpvg5gg10 +``` + +> Note: this step is showing during creation of Kubernetes Cluster. + + + +- After running 2nd and 3rd commands showing in above image you will get output shows like in the below image (no need to run number 1 command because we already logged in to IBM Cloud) + +Output + + +> Now we are able to run commands of kubectl. + +#### Run kubectl commands to verify the deployment +Make sure all the pods of Pulsar are runnig. Get the service URL and broker URL for publishing and consuming the messages. + + +- We will add "Pulsar" Helm repo in VM and clone the repo of Apache Pulsar from Github, below is all the commands. + +> [Installation of Pulsar helm in minikube cluster](https://pulsar.apache.org/docs/getting-started-helm/) this document is for minikube cluster we are taking reference from that. + +1. Add Pulsar chart repo + +```bash +$ helm repo add apache https://pulsar.apache.org/charts +$ helm repo update +$ helm repo list +``` + +Output + + +2. Clone the Pulsar Helm chart repository, go inside the pulsar-helm-chart directory + +```bash +git clone https://github.com/apache/pulsar-helm-chart +cd pulsar-helm-chart +``` + +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 -n default -k asia -c +``` + +Output + + +4. Use the Pulsar Helm chart to install a Pulsar cluster to Kubernetes. + +```bash +helm install --values examples/values-minikube.yaml --set initialize=true asia apache/pulsar +``` + +:::note + +You need to specify`--set initialize=true`when installing Pulsar the first time. This command installs and starts Apache Pulsar. + +::: + +Output + + +5. Check the status of all pods. + +```bash +kubectl get pods +``` +If all pods start up successfully, you can see that the`STATUS`is changed to`Running`or`Completed` + +Output + + +6. Check the status of all services + +```bash + kubectl get services +``` + +Output + + +> Output of above command will give us `services URL` and `broker URL`, proxy external ip is for both just change ports (for service URL port is 80 and for broker URL port is 6650 this is default) +If all of these commands are successful, Pulsar clients can now use your cluster! Review Comment: ```suggestion If you execute all the commands successfully, you can use the Pulsar client to connect to ?? clusters and produce and consume messages through proxy external IPs. ``` Do you intend to mean this? ########## versioned_docs/version-2.10.x/deploy-ibm.md: ########## @@ -0,0 +1,237 @@ +--- +id: deploy-ibm +title: Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart +sidebar_label: "IBM Cloud Services" +original_id: deploy-ibm +--- +# Apache Pulsar Installation on IBM Kubernetes Cluster through Helm chart + +:::note + + This doc referes to the Apache pulsar 2.93 Version. if you want to upgrade the Apache Pulsar version you need to follow the [helm-upgrade](https://pulsar.apache.org/docs/2.10.x/helm-upgrade/) Document for upgrade on the perticular version. + +::: + + + +- [Setup a virtual machine (VM) on IBM Cloud.](#create-vm-on-ibm-cloud) +- [Create Kubernete cluster on IBM Cloud.](#create-kubernetes-cluster-on-ibm) +- [Prepare VM for connecting to Kubernetes cluster and deploy Pulsar Helm chart on Kubernetes cluster.](#prepare-vm-for-connecting-to-kubernetes-cluster-and-deploy-pulsar-helm-chart-on-kubernetes-cluster) +- [Verify the deployment.](#run-kubectl-commands-to-verify-the-deployment) Review Comment: Use an ordered (numbered) list when the sequence is significant, for example, when writing procedures or ranking items. If the items in a list represent rules or other types of information that you want to refer to, you can refer to them by number. Details see https://docs.google.com/document/d/1lc5j4RtuLIzlEYCBo97AC8-U_3Erzs_lxpkDuseU0n4/edit#bookmark=id.yoetnldi5amd -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
