This project includes helm charts developed to deploy orchestra cities (thus covering as well some FIWARE services).
The repository includes the following charts:
- Orion Context Broker
- QuantumLeap
- CrateDB (Backend for QuantumLeap)
- StreamSets Data Collector
- Nosql Client
- IoT Agent
- IoT Agent Manager
The following charts are available as packages but synched from external repos:
Be aware that some packages have dependencies on other publicly available charts.
Contributions are more than welcome in the form of pull requests.
You can either pick one of the open issues to work on, or provide enhancements according to your own needs. In any case, we suggest getting in touch beforehand to make sure the contribution will be aligned with the current development status.
To contribute:
- Fork the repository and clone the fork to your local development environment
- Identify a modular contribution (1 chart per contribution)
- Create a branch in your repository where you tackle the "modular
contributions"
- For multiple contributions tackling different functionalities, create different branches
- Create a pull request against our repository
- Wait for the review
- Implement required changes
- Repeat until approval
- Done :) You can delete the branch in your repository.
- We will take care of publishing the chart in the repo (hopefully in some point this will be automated on merge)
Ultimately, contributing guides should keep aligned with those suggested by FIWARE (see here).
The process is automated: once a merge request lands in the repo, the catalogue is updated.
In case you need to update manually:
- The owners will package the chart from the master repo:
$ helm package charts/<CHART_NAME>
- The owners will then will create a new branch of the documentation branch
gh-pages
- The owners will update the index:
$ helm repo index . --url https://orchestracities.github.io/charts/
- The owners will commit the package and the updated index.
- The owners will issues a PR to the
gh-pages
branch.