platform-mesh - helm-charts

Warning

This Repository is under development and not ready for productive use. It is in an alpha stage. That means APIs and concepts may change on short notice including breaking changes or complete removal of apis.

Description

The helm-charts repository contains helm charts used for the deployment of platform-mesh instance on Kubernetes. It also contains CI/CD scripts for buildidng and publishing relevant artefacts like charts and OCM components.

Directory structure

• .github/workflows - GHA workflows to test, build and publish charts
• .ocm - OCM component constructor files for individual component references
• charts - a folder containing the HELM charts
• installation - Installation: declarative Helm release to deploy Platform Mesh to a Kubernetes cluster (the default path)
• development - Developer setup: bring up Platform Mesh locally on kind, either from published components (PINNED, default) or built locally (DEV)
• doc-templates - templates used to generate charts documentation
• Taskfile.yaml - script automation used by the Taskfile cli

Getting started

• Installing Platform Mesh (the default path): follow the Installation guide to deploy to a Kubernetes cluster with Helm.
• Evaluating or developing locally: follow the Developer setup to run Platform Mesh on a local kind cluster.
• For adding a new service to PlatformMesh, see the Adding a Service guide.

Releasing

The release is performed automatically through a GitHub Actions Workflow.

All the released versions will be available through access to GitHub (as any other Golang Module).

Requirements

The following is required to work with the helm charts in this repository:

• helm to work with the helm charts
• ct to run the tests for the charts
• Taskfile to run the tasks in Taskfile.yaml
• kind to run the local Kubernetes cluster for testing and development

Contributing

Please refer to the CONTRIBUTING.md file in this repository for instructions on how to contribute to platform-mesh.

For detailed instructions regarding local development see the Developer setup README.md.

Code of Conduct

Please refer to our Code of Conduct for information on the expected conduct for contributing to Platform Mesh.