{"id":29006428,"url":"https://github.com/cloudamqp/lavinmq-operator","last_synced_at":"2025-06-25T12:31:55.588Z","repository":{"id":294424225,"uuid":"951947738","full_name":"cloudamqp/lavinmq-operator","owner":"cloudamqp","description":null,"archived":false,"fork":false,"pushed_at":"2025-05-20T10:28:45.000Z","size":196,"stargazers_count":3,"open_issues_count":10,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-20T11:39:48.027Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloudamqp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-03-20T13:48:07.000Z","updated_at":"2025-05-19T21:27:36.000Z","dependencies_parsed_at":"2025-05-20T21:46:18.340Z","dependency_job_id":null,"html_url":"https://github.com/cloudamqp/lavinmq-operator","commit_stats":null,"previous_names":["cloudamqp/lavinmq-operator"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/cloudamqp/lavinmq-operator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudamqp%2Flavinmq-operator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudamqp%2Flavinmq-operator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudamqp%2Flavinmq-operator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudamqp%2Flavinmq-operator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudamqp","download_url":"https://codeload.github.com/cloudamqp/lavinmq-operator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudamqp%2Flavinmq-operator/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261874576,"owners_count":23223143,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-25T12:30:44.589Z","updated_at":"2025-06-25T12:31:55.560Z","avatar_url":"https://github.com/cloudamqp.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# LavinMQ-operator\n\n## Description\nThe LavinMQ Operator provides a way to deploy and manage LavinMQ clusters on Kubernetes. It leverages Kubernetes Custom Resource Definitions (CRDs) to define and manage LavinMQ instances as native Kubernetes resources.\n\nSupported features:\n\n- LavinMQ version upgrades\n- Scaling - Horizontal and vertical.\n- Increasing disk size\n- Setting LavinMQ specific configurations. Rolling restarts automatically applied.\n\nKnown issues/limitations/roadmap:\n\n- Scaling disk is only supporting disk size increase\n- Updating TLS contents do not apply a restart/reload of LavinMQs state. A manual restart/reapply is needed\n- ETCD has to be managed by end-user and is not provided via this operator. It is on the roadmap though\n  - There is a example in config/samples/etcd_cluster.yaml to setup an etcd cluster using https://github.com/etcd-io/etcd-operator, the operator has to be pre-installed to use this.\n  - A meta operator is being considered to manage the etcd and lavinmq simultaneously, see related issue https://github.com/cloudamqp/lavinmq-operator/issues/39\n- Monitoring capability is currently limited to what LavinMQ itself provides.\n\nFollowing [operator-sdks Capability Levels](https://sdk.operatorframework.io/docs/overview/operator-capabilities/), the operator can be considered as a Level 3 implementation currently.\n\n## Supported Configurations\n\nThe LavinMQ Operator supports a wide range of configurations, as defined in the `lavinmq_types.go` file. Here's a detailed description of the supported features and configurations:\n\n1. **Image Configuration:**\n   - The operator allows specifying a custom Docker image for LavinMQ using the `image` field. By default, it uses `cloudamqp/lavinmq:2.3.0`.\n\n2. **Replicas:**\n   - You can configure the number of replicas for the LavinMQ cluster. The value must be between 1 and 3, with a default of 1.\n\n3. **Resource Management:**\n   - `resources` field allows specifying CPU and memory requests/limits for the LavinMQ pods.\n\n4. **Persistent Storage:**\n   - `dataVolumeClaim` field is required and defines the PersistentVolumeClaim (PVC) for storing data. It enforces the `ReadWriteOnce` access mode.\n\n5. **Etcd Integration:**\n   - `etcdEndpoints` field allows specifying a list of etcd endpoints for clustering. Required if running more than a single node of LavinMQ\n\n6. **TLS Configuration:**\n   - `tlsSecret` field references a Kubernetes Secret containing TLS certificates for secure communication.\n\n7. **LavinMQ Configuration:**\n   - The `config` field allows detailed customization of LavinMQ behavior through the following sub-configurations, see [LavinMQ Configuration documentation](https://lavinmq.com/documentation/configuration-files) for extended list of configurations\n     - **Main Configuration:**\n       - Consumer timeout, default prefetch, default user/password, disk space thresholds, logging levels, and more.\n     - **Mgmt Configuration:**\n       - HTTP/HTTPS management ports and configurations related to the UI.\n     - **AMQP Configuration:**\n       - Channel limits, frame size, heartbeat intervals, and AMQP/AMQPS ports, etc...\n     - **MQTT Configuration:**\n       - In-flight message limits and MQTT/MQTTS ports.\n     - **Clustering Configuration:**\n       - Maximum unsynced actions in the cluster.\n\n## Provided examples\nIn `config/samples/`\n\n\n## Getting Started\n\n### Prerequisites\n- go version v1.22.0+\n- docker version 17.03+.\n- kubectl version v1.11.3+.\n- Access to a Kubernetes v1.11.3+ cluster.\n\n### To Deploy on the cluster\n**Build and push your image to the location specified by `IMG`:**\n\n```sh\nmake docker-build docker-push IMG=\u003csome-registry\u003e/lavinmq-operator:tag\n```\n\n**NOTE:** This image ought to be published in the personal registry you specified.\nAnd it is required to have access to pull the image from the working environment.\nMake sure you have the proper permission to the registry if the above commands don’t work.\n\n**Install the CRDs into the cluster:**\n\n```sh\nmake install\n```\n\n**Deploy the Manager to the cluster with the image specified by `IMG`:**\n\n```sh\nmake deploy IMG=\u003csome-registry\u003e/lavinmq-operator:tag\n```\n\n\u003e **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin\nprivileges or be logged in as admin.\n\n**Create instances of your solution**\nYou can apply the samples (examples) from the config/sample:\n\n```sh\nkubectl apply -k config/samples/\n```\n\n\u003e**NOTE**: Ensure that the samples has default values to test it out.\n\n### To Uninstall\n**Delete the instances (CRs) from the cluster:**\n\n```sh\nkubectl delete -k config/samples/\n```\n\n**Delete the APIs(CRDs) from the cluster:**\n\n```sh\nmake uninstall\n```\n\n**UnDeploy the controller from the cluster:**\n\n```sh\nmake undeploy\n```\n\n## Project Distribution\n\nFollowing are the steps to build the installer and distribute this project to users.\n\n1. Build the installer for the image built and published in the registry:\n\n```sh\nmake build-installer IMG=\u003csome-registry\u003e/lavinmq-operator:tag\n```\n\nNOTE: The makefile target mentioned above generates an 'install.yaml'\nfile in the dist directory. This file contains all the resources built\nwith Kustomize, which are necessary to install this project without\nits dependencies.\n\n2. Using the installer\n\nUsers can just run kubectl apply -f \u003cURL for YAML BUNDLE\u003e to install the project, i.e.:\n\n```sh\nkubectl apply -f https://github.com/cloudamqp/lavinmq-operator/releases/download/\u003cversion\u003e/install.yaml\n```\n\n## Contributing\n// TODO(user): Add detailed information on how you would like others to contribute to this project\n\n**NOTE:** Run `make help` for more information on all potential `make` targets\n\nMore information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)\n\n## License\n\nCopyright 2025.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudamqp%2Flavinmq-operator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudamqp%2Flavinmq-operator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudamqp%2Flavinmq-operator/lists"}