-
Notifications
You must be signed in to change notification settings - Fork 1.5k
feat(helm): add Helm chart for ActiveMQ broker deployment #1761
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jbonofre
wants to merge
4
commits into
apache:main
Choose a base branch
from
jbonofre:gh-1754
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,641
−0
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
bca7dc4
feat(helm): add Helm chart for ActiveMQ broker deployment
jbonofre 060d8f1
fix(helm): remove HorizontalPodAutoscaler to prevent isolated brokers
jbonofre 2cd2602
fix(helm): update image repository and appVersion
jbonofre 113683c
fix(helm): set appVersion to 6.2.1
jbonofre File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Patterns to ignore when building packages. | ||
| .DS_Store | ||
| # Common VCS dirs | ||
| .git/ | ||
| .gitignore | ||
| .bzr/ | ||
| .bzrignore | ||
| .hg/ | ||
| .hgignore | ||
| .svn/ | ||
| # Common backup files | ||
| *.swp | ||
| *.bak | ||
| *.tmp | ||
| *.orig | ||
| *~ | ||
| # Various IDEs | ||
| .project | ||
| .idea/ | ||
| *.tmproj | ||
| .vscode/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you under the Apache License, Version 2.0 (the | ||
| # "License"); you may not use this file except in compliance | ||
| # with the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, | ||
| # software distributed under the License is distributed on an | ||
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| # KIND, either express or implied. See the License for the | ||
| # specific language governing permissions and limitations | ||
| # under the License. | ||
|
|
||
| apiVersion: v2 | ||
| name: activemq | ||
| description: Apache ActiveMQ - the most popular open source, multi-protocol, Java-based message broker | ||
| type: application | ||
| version: 6.3.0-SNAPSHOT | ||
| appVersion: 6.2.1 | ||
| home: https://activemq.apache.org/ | ||
| icon: https://activemq.apache.org/assets/img/activemq_logo_icon.png | ||
| sources: | ||
| - https://github.com/apache/activemq | ||
| keywords: | ||
| - activemq | ||
| - messaging | ||
| - jms | ||
| - broker | ||
| - amqp | ||
| - mqtt | ||
| - stomp | ||
| maintainers: | ||
| - name: Apache ActiveMQ PMC | ||
| email: dev@activemq.apache.org | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,309 @@ | ||
| <!-- | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
| --> | ||
|
|
||
| # ActiveMQ Helm Chart | ||
|
|
||
| A Helm chart for deploying [Apache ActiveMQ](https://activemq.apache.org/) on Kubernetes. | ||
|
|
||
| ## Introduction | ||
|
|
||
| This chart bootstraps an Apache ActiveMQ broker deployment on a Kubernetes cluster using the [Helm](https://helm.sh) package manager. It deploys ActiveMQ as a StatefulSet with persistent storage for the KahaDB message store. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Kubernetes 1.24+ | ||
| - Helm 3.10+ | ||
| - PV provisioner support in the underlying infrastructure (if persistence is enabled) | ||
|
|
||
| ## Installing the Chart | ||
|
|
||
| To install the chart with the release name `my-activemq`: | ||
|
|
||
| ```bash | ||
| helm install my-activemq ./helm/activemq | ||
| ``` | ||
|
|
||
| To install with custom values: | ||
|
|
||
| ```bash | ||
| helm install my-activemq ./helm/activemq -f my-values.yaml | ||
| ``` | ||
|
|
||
| ## Uninstalling the Chart | ||
|
|
||
| To uninstall/delete the `my-activemq` deployment: | ||
|
|
||
| ```bash | ||
| helm uninstall my-activemq | ||
| ``` | ||
|
|
||
| > **Note:** Uninstalling the chart does not delete PersistentVolumeClaims created by the StatefulSet. To delete them: | ||
| > ```bash | ||
| > kubectl delete pvc -l app.kubernetes.io/instance=my-activemq | ||
| > ``` | ||
|
|
||
| ## Configuration | ||
|
|
||
| ### General | ||
|
|
||
| | Parameter | Description | Default | | ||
| |-----------|-------------|---------| | ||
| | `replicaCount` | Number of broker replicas | `1` | | ||
| | `image.repository` | Container image repository | `apache/activemq-classic` | | ||
| | `image.tag` | Image tag (defaults to chart `appVersion`) | `""` | | ||
| | `image.pullPolicy` | Image pull policy | `IfNotPresent` | | ||
| | `imagePullSecrets` | Image pull secrets for private registries | `[]` | | ||
| | `nameOverride` | Override the chart name | `""` | | ||
| | `fullnameOverride` | Override the full release name | `""` | | ||
| | `terminationGracePeriodSeconds` | Graceful shutdown timeout | `60` | | ||
|
|
||
| ### Broker | ||
|
|
||
| | Parameter | Description | Default | | ||
| |-----------|-------------|---------| | ||
| | `broker.credentials.username` | Broker connection username | `admin` | | ||
| | `broker.credentials.password` | Broker connection password | `admin` | | ||
| | `broker.credentials.existingSecret` | Use an existing secret for connection credentials | `""` | | ||
| | `broker.web.username` | Web console username | `admin` | | ||
| | `broker.web.password` | Web console password | `admin` | | ||
| | `broker.web.existingSecret` | Use an existing secret for web credentials | `""` | | ||
| | `broker.jmx.enabled` | Enable JMX | `false` | | ||
| | `broker.jmx.username` | JMX username | `admin` | | ||
| | `broker.jmx.password` | JMX password | `activemq` | | ||
| | `broker.jmx.existingSecret` | Use an existing secret for JMX credentials | `""` | | ||
| | `broker.jvmMemory` | JVM memory options | `"-Xms64M -Xmx1G"` | | ||
| | `broker.jvmOpts` | Additional JVM options | `""` | | ||
| | `broker.activemqXml` | Custom `activemq.xml` content | `""` | | ||
| | `broker.jettyXml` | Custom `jetty.xml` content | `""` | | ||
| | `broker.log4j2Properties` | Custom `log4j2.properties` content | `""` | | ||
|
|
||
| ### Service | ||
|
|
||
| | Parameter | Description | Default | | ||
| |-----------|-------------|---------| | ||
| | `service.type` | Broker service type | `ClusterIP` | | ||
| | `service.annotations` | Broker service annotations | `{}` | | ||
| | `service.openwire.enabled` | Enable OpenWire transport | `true` | | ||
| | `service.openwire.port` | OpenWire service port | `61616` | | ||
| | `service.amqp.enabled` | Enable AMQP transport | `true` | | ||
| | `service.amqp.port` | AMQP service port | `5672` | | ||
| | `service.stomp.enabled` | Enable STOMP transport | `true` | | ||
| | `service.stomp.port` | STOMP service port | `61613` | | ||
| | `service.mqtt.enabled` | Enable MQTT transport | `true` | | ||
| | `service.mqtt.port` | MQTT service port | `1883` | | ||
| | `service.ws.enabled` | Enable WebSocket transport | `true` | | ||
| | `service.ws.port` | WebSocket service port | `61614` | | ||
|
|
||
| ### Web Console | ||
|
|
||
| | Parameter | Description | Default | | ||
| |-----------|-------------|---------| | ||
| | `webConsole.type` | Web console service type | `ClusterIP` | | ||
| | `webConsole.port` | Web console HTTP port | `8161` | | ||
| | `webConsole.annotations` | Web console service annotations | `{}` | | ||
|
|
||
| ### Ingress | ||
|
|
||
| | Parameter | Description | Default | | ||
| |-----------|-------------|---------| | ||
| | `ingress.enabled` | Enable ingress for the web console | `false` | | ||
| | `ingress.className` | Ingress class name | `""` | | ||
| | `ingress.annotations` | Ingress annotations | `{}` | | ||
| | `ingress.hosts` | Ingress hosts configuration | See `values.yaml` | | ||
| | `ingress.tls` | Ingress TLS configuration | `[]` | | ||
|
|
||
| ### Persistence | ||
|
|
||
| | Parameter | Description | Default | | ||
| |-----------|-------------|---------| | ||
| | `persistence.enabled` | Enable persistent storage for KahaDB | `true` | | ||
| | `persistence.storageClassName` | PVC storage class | `""` | | ||
| | `persistence.accessModes` | PVC access modes | `["ReadWriteOnce"]` | | ||
| | `persistence.size` | PVC storage size | `8Gi` | | ||
| | `persistence.annotations` | PVC annotations | `{}` | | ||
| | `persistence.selector` | PVC selector for matching PVs | `{}` | | ||
|
|
||
| ### Resources and Probes | ||
|
|
||
| | Parameter | Description | Default | | ||
| |-----------|-------------|---------| | ||
| | `resources.requests.cpu` | CPU request | `500m` | | ||
| | `resources.requests.memory` | Memory request | `1Gi` | | ||
| | `resources.limits.cpu` | CPU limit | `2` | | ||
| | `resources.limits.memory` | Memory limit | `2Gi` | | ||
| | `startupProbe` | Startup probe (TCP on OpenWire port) | See `values.yaml` | | ||
| | `livenessProbe` | Liveness probe (HTTP on web console) | See `values.yaml` | | ||
| | `readinessProbe` | Readiness probe (TCP on OpenWire port) | See `values.yaml` | | ||
|
|
||
| ### Security | ||
|
|
||
| | Parameter | Description | Default | | ||
| |-----------|-------------|---------| | ||
| | `serviceAccount.create` | Create a service account | `true` | | ||
| | `serviceAccount.annotations` | Service account annotations | `{}` | | ||
| | `serviceAccount.name` | Service account name | `""` | | ||
| | `podSecurityContext.runAsNonRoot` | Run as non-root | `true` | | ||
| | `podSecurityContext.runAsUser` | Run as UID | `1000` | | ||
| | `podSecurityContext.runAsGroup` | Run as GID | `1000` | | ||
| | `podSecurityContext.fsGroup` | Filesystem group | `1000` | | ||
| | `securityContext.allowPrivilegeEscalation` | Allow privilege escalation | `false` | | ||
| | `securityContext.capabilities.drop` | Dropped capabilities | `["ALL"]` | | ||
|
|
||
| ### Availability | ||
|
|
||
| | Parameter | Description | Default | | ||
| |-----------|-------------|---------| | ||
| | `podDisruptionBudget.enabled` | Enable Pod Disruption Budget | `false` | | ||
| | `podDisruptionBudget.minAvailable` | Minimum available pods | `1` | | ||
|
|
||
| ### Monitoring | ||
|
|
||
| | Parameter | Description | Default | | ||
| |-----------|-------------|---------| | ||
| | `serviceMonitor.enabled` | Enable Prometheus ServiceMonitor | `false` | | ||
| | `serviceMonitor.interval` | Scrape interval | `30s` | | ||
| | `serviceMonitor.labels` | Additional ServiceMonitor labels | `{}` | | ||
|
|
||
| ### Scheduling | ||
|
|
||
| | Parameter | Description | Default | | ||
| |-----------|-------------|---------| | ||
| | `nodeSelector` | Node selector | `{}` | | ||
| | `tolerations` | Tolerations | `[]` | | ||
| | `affinity` | Affinity rules | `{}` | | ||
| | `topologySpreadConstraints` | Topology spread constraints | `[]` | | ||
| | `podAnnotations` | Pod annotations | `{}` | | ||
| | `podLabels` | Pod labels | `{}` | | ||
|
|
||
| ### Extensibility | ||
|
|
||
| | Parameter | Description | Default | | ||
| |-----------|-------------|---------| | ||
| | `extraEnv` | Extra environment variables | `[]` | | ||
| | `extraVolumes` | Extra volumes | `[]` | | ||
| | `extraVolumeMounts` | Extra volume mounts | `[]` | | ||
| | `initContainers` | Init containers | `[]` | | ||
|
|
||
| ## Accessing ActiveMQ | ||
|
|
||
| ### Web Console | ||
|
|
||
| The ActiveMQ Web Console is available on port 8161. To access it locally: | ||
|
|
||
| ```bash | ||
| kubectl port-forward svc/my-activemq-web 8161:8161 | ||
| ``` | ||
|
|
||
| Then open http://localhost:8161 in your browser and log in with the configured credentials (default: `admin`/`admin`). | ||
|
|
||
| ### Broker Connections | ||
|
|
||
| Applications can connect to ActiveMQ using the following protocols from within the cluster: | ||
|
|
||
| | Protocol | URL | | ||
| |----------|-----| | ||
| | OpenWire (JMS) | `tcp://my-activemq:61616` | | ||
| | AMQP | `amqp://my-activemq:5672` | | ||
| | STOMP | `stomp://my-activemq:61613` | | ||
| | MQTT | `mqtt://my-activemq:1883` | | ||
| | WebSocket | `ws://my-activemq:61614` | | ||
|
|
||
| To connect from outside the cluster, use port-forwarding: | ||
|
|
||
| ```bash | ||
| kubectl port-forward svc/my-activemq 61616:61616 | ||
| ``` | ||
|
|
||
| Then connect to `tcp://localhost:61616`. | ||
|
|
||
| ## Custom Configuration | ||
|
|
||
| You can provide a custom `activemq.xml` directly in your values file: | ||
|
|
||
| ```yaml | ||
| broker: | ||
| activemqXml: | | ||
| <beans xmlns="http://www.springframework.org/schema/beans" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://www.springframework.org/schema/beans | ||
| http://www.springframework.org/schema/beans/spring-beans.xsd | ||
| http://activemq.apache.org/schema/core | ||
| http://activemq.apache.org/schema/core/activemq-core.xsd"> | ||
| <broker xmlns="http://activemq.apache.org/schema/core" | ||
| brokerName="localhost" dataDirectory="${activemq.data}"> | ||
| <!-- your custom configuration here --> | ||
| </broker> | ||
| <import resource="jetty.xml"/> | ||
| </beans> | ||
| ``` | ||
|
|
||
| Similarly, you can customize `jetty.xml` and `log4j2.properties` via `broker.jettyXml` and `broker.log4j2Properties`. | ||
|
|
||
| See the [examples/](examples/) directory for complete example values files: | ||
| - `activemq-custom.yaml` - Custom broker configuration with `activemq.xml` | ||
| - `production.yaml` - Production-ready settings with external secrets, ingress, and anti-affinity | ||
|
|
||
| ## Credentials | ||
|
|
||
| Credentials are stored in Kubernetes Secrets. For production, use existing secrets instead of plaintext values: | ||
|
|
||
| ```yaml | ||
| broker: | ||
| credentials: | ||
| existingSecret: "my-activemq-credentials" | ||
| web: | ||
| existingSecret: "my-activemq-web-credentials" | ||
| ``` | ||
|
|
||
| Create the secrets beforehand: | ||
|
|
||
| ```bash | ||
| kubectl create secret generic my-activemq-credentials \ | ||
| --from-literal=connection-username=admin \ | ||
| --from-literal=connection-password=s3cur3p4ss | ||
|
|
||
| kubectl create secret generic my-activemq-web-credentials \ | ||
| --from-literal=web-username=admin \ | ||
| --from-literal=web-password=s3cur3p4ss | ||
| ``` | ||
|
|
||
| ## Persistence | ||
|
|
||
| The ActiveMQ image stores message data (KahaDB) at `/opt/apache-activemq/data`. | ||
|
|
||
| By default, the chart creates a PersistentVolumeClaim for each pod via the StatefulSet's `volumeClaimTemplates`. The volume is provisioned dynamically using the cluster's default StorageClass. | ||
|
|
||
| To disable persistence (data will be lost on pod restart): | ||
|
|
||
| ```yaml | ||
| persistence: | ||
| enabled: false | ||
| ``` | ||
|
|
||
| ## Monitoring | ||
|
|
||
| To enable Prometheus monitoring via the ServiceMonitor CRD: | ||
|
|
||
| ```yaml | ||
| serviceMonitor: | ||
| enabled: true | ||
| interval: 30s | ||
| ``` | ||
|
|
||
| This requires the [Prometheus Operator](https://prometheus-operator.dev/) to be installed in your cluster. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are we launching this on 6.3? Not back porting it to 6.2?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm fine to create a backport on 6.2.x branch.
That said, regarding the number of improvements for 6.3.0, I will focus on 6.3.0 as first citizen 😄