├── .gitignore ├── imgs ├── completed.png └── zeebe-on-k8s.png ├── emergency-process.bpmn ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | .idea/ 3 | -------------------------------------------------------------------------------- /imgs/completed.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/salaboy/zeebe-k8s-getting-started/HEAD/imgs/completed.png -------------------------------------------------------------------------------- /imgs/zeebe-on-k8s.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/salaboy/zeebe-k8s-getting-started/HEAD/imgs/zeebe-on-k8s.png -------------------------------------------------------------------------------- /emergency-process.bpmn: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | SequenceFlow_1kfpnnj 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | SequenceFlow_1kfpnnj 15 | SequenceFlow_18oq9dv 16 | 17 | 18 | 19 | 20 | 21 | 22 | SequenceFlow_113qjg3 23 | SequenceFlow_0xo4771 24 | 25 | 26 | SequenceFlow_0xo4771 27 | 28 | 29 | 30 | SequenceFlow_18oq9dv 31 | SequenceFlow_113qjg3 32 | SequenceFlow_0dlz63c 33 | 34 | 35 | 36 | =emergencyType = "Injured" 37 | 38 | 39 | 40 | 41 | 42 | SequenceFlow_0dlz63c 43 | SequenceFlow_0nybe3i 44 | 45 | 46 | =emergencyType = "Fire" 47 | 48 | 49 | SequenceFlow_0nybe3i 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Zeebe on Kubernetes 2 | This repository contains the links to get an example application with Zeebe running inside a Kubernetes Cluster. This example also includes an example Workflow Definition and links to a Zeebe Worker based on Spring Boot. This example also includes the use of the Zeebe Modeler and the `zbctl` command line tool. 3 | 4 | ![Zeebe on K8s](imgs/zeebe-on-k8s.png) 5 | 6 | # Pre Requisites 7 | - Git / Java / Maven 8 | - Kubernetes Cluster + `kubectl` 9 | - Local: [Kubernetes KIND](https://github.com/kubernetes-sigs/kind), Minikube, MicroK8s 10 | - Remote: GKE, Azure, EKS 11 | - HELM cli 12 | - (Optional) Zeebe Modeler 13 | - (Optional) Zeebe CTL 14 | - (Optional) Spring Boot Zeebe Worker 15 | 16 | You can run this example against any Kubernetes Cluster. 17 | 18 | You can also find a Spring Boot Worker which implements the `classify`, `hospital` and `firefighters` workers for the `BPMN Service Tasks` included in the example process here [Zeebe Spring Boot Example Worker](https://github.com/salaboy/zeebe-worker-spring-boot-example) 19 | 20 | # Install Zeebe Helm Charts into your Kubernetes Cluster 21 | 22 | Follow the official documentation on how to install the official [Zeebe Helm Charts](https://stage.docs.zeebe.io/kubernetes/README.html) into Kubernetes. 23 | 24 | ### Zeebe Modeler 25 | If you are in Mac OSX you can install it with homebrew: 26 | ``` 27 | > brew cask install zeebe-modeler 28 | ``` 29 | 30 | Or download from here: [Zeebe Modeler Releases](https://github.com/zeebe-io/zeebe-modeler/releases) 31 | 32 | You can open and modify the [`emergency-process.bpmn`](https://github.com/salaboy/zeebe-k8s-getting-started/blob/master/emergency-process.bpmn) file with it now. 33 | 34 | ## Checking Zeebe Installation 35 | ``` 36 | > kubectl get pods 37 | ``` 38 | 39 | Should return something like: 40 | ``` 41 | NAME READY STATUS RESTARTS AGE 42 | elasticsearch-master-0 1/1 Running 0 10m 43 | elasticsearch-master-1 1/1 Running 0 10m 44 | elasticsearch-master-2 1/1 Running 0 10m 45 | -nginx-ingress-controller-5cf6dd7894-s9xkr 1/1 Running 0 10m 46 | -nginx-ingress-default-backend-f5454db5-8jgpq 1/1 Running 0 10m 47 | -operate-5d4867d6d-qxqq5 1/1 Running 2 10m 48 | -zeebe-0 1/1 Running 0 10m 49 | -zeebe-1 1/1 Running 0 10m 50 | -zeebe-2 1/1 Running 0 10m 51 | ``` 52 | 53 | ## Interact with the services inside the Cluster 54 | In order to interact with the services inside the cluster you need to use `port-forward` to route traffic from your environment to the cluster. By default, the Zeebe Cluster is not exposed, even if you have deployed the Zeebe Full Helm Chart which includes an Ingress Controller. 55 | ``` 56 | > kubectl port-forward svc/-zeebe 26500:26500 57 | ``` 58 | 59 | Now you can connect and execute operations against your newly created Zeebe cluster. 60 | Notice that you need to keep running the `port-forward` command to be able to communicate with the remote cluster. 61 | 62 | ### Using the Zeebe CLI - Command Line Interface (zbctl) 63 | You can get the `zbctl` tool from the official [Zeebe Release Page](https://github.com/zeebe-io/zeebe/releases) 64 | 65 | `zbctl` by default is configured to point to `localhost:26500` to interact with a cluster, and because we are running `port-forward` from our environment to the cluster, our `26500` port is redirected to the cluster service. 66 | 67 | Download and add `zbctl` to your `PATH`, and now you can check the connection with your cluster: 68 | ``` 69 | > zbctl status --insecure 70 | ``` 71 | 72 | This should return something like this: 73 | ``` 74 | Cluster size: 3 75 | Partitions count: 3 76 | Replication factor: 3 77 | Brokers: 78 | Broker 0 - salaboy-zeebe-0.salaboy-zeebe.default.svc.cluster.local:26501 79 | Partition 1 : Follower 80 | Partition 2 : Leader 81 | Partition 3 : Follower 82 | Broker 1 - salaboy-zeebe-1.salaboy-zeebe.default.svc.cluster.local:26501 83 | Partition 1 : Leader 84 | Partition 2 : Follower 85 | Partition 3 : Leader 86 | Broker 2 - salaboy-zeebe-2.salaboy-zeebe.default.svc.cluster.local:26501 87 | Partition 1 : Follower 88 | Partition 2 : Follower 89 | Partition 3 : Follower 90 | ``` 91 | 92 | Once you have your connection to your cluster you can deploy our process defintion by running: 93 | ``` 94 | > zbctl deploy emergency-process.bpmn --insecure 95 | ``` 96 | 97 | Next step is to create Workflow Instances. Notice that you can send variables: 98 | ``` 99 | > zbctl create instance EMERGENCY_PROCESS --variables "{\"emergencyReason\" : \"person\"}" --insecure 100 | ``` 101 | 102 | or/and 103 | ``` 104 | > zbctl create instance EMERGENCY_PROCESS --variables "{\"emergencyReason\" : \"building on fire\"}" --insecure 105 | ``` 106 | 107 | ## Accessing Operate from outside the cluster 108 | The `Zeebe Full HELM Charts` install an Ingress Controller. If this is deployed in a cloud provider, it should provision a LoadBalancer which will expose an External IP that can be used as the main entry point to access all the services/applications that are configured to have Ingress Routes. 109 | 110 | You can find the External IP by running: 111 | ``` 112 | > kubectl get svc 113 | ``` 114 | 115 | You should see something like: 116 | ``` 117 | NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE 118 | -nginx-ingress-controller LoadBalancer 10.109.108.4 80:30497/TCP,443:32232/TCP 63m 119 | ``` 120 | 121 | Where the `` under the `EXTERNAL-IP` column should change to a public IP that you (and other users) should be able to access from outside the Cluster. You might need to check your Cloud Provider specific configuration if that doesn't work. 122 | 123 | If you are running in Kubernetes KIND, you will need to `port-forward` to the Ingress Controller main entry point due KIND doesn't support LoadBalancers. You can do that by running in a different terminal: 124 | ``` 125 | > kubectl port-forward svc/-nginx-ingress-controller 8080:80 126 | ``` 127 | 128 | Then you should be able to access Operate at [http://localhost:8080](http://localhost:8080/) 129 | 130 | Using `demo`/`demo` for credentials. 131 | 132 | At this point, if you create two process instances you will see that they are both stuck at the `Classify Emergency` task. This is because you don't have workers for such tasks, so the process will wait in that state until we provide one of these workers. 133 | 134 | ### Starting a simple Spring Boot Zeebe Worker 135 | 136 | Clone and run the Simple Zeebe Spring Boot Worker: 137 | ``` 138 | > git clone https://github.com/salaboy/zeebe-worker-spring-boot-example 139 | > cd zeebe-worker-spring-boot-example/ 140 | > mvn spring-boot:run 141 | ``` 142 | 143 | Once again, the worker is configured by default to connect to `localhost:26500` to fetch Jobs. If everything is up and running the worker will start and connect, automatically completing the pending tasks in our Workflow Instances. 144 | If you refresh Operate (http://localhost:8080) you will find both Instances completed: 145 | 146 | ![Completed Instances](imgs/completed.png) 147 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------