https://github.com/ndustrialio/charts
Helm charts
https://github.com/ndustrialio/charts
library
Last synced: 6 months ago
JSON representation
Helm charts
- Host: GitHub
- URL: https://github.com/ndustrialio/charts
- Owner: ndustrialio
- Created: 2020-11-06T03:13:17.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-10-30T17:27:44.000Z (8 months ago)
- Last Synced: 2025-12-26T21:09:24.172Z (6 months ago)
- Topics: library
- Language: Mustache
- Homepage: https://ndustrialio.github.io/charts
- Size: 535 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ndustrial.io Helm Charts
[](https://github.com/ndustrialio/charts/actions?query=workflow%3ACI)
This repository hosts the **[ndustrial.io](https://ndustrial.io) Helm Charts** for deploying to [Kubernetes](https://kubernetes.io/).
## Usage
[Helm](https://helm.sh) must be installed to use the charts.
Please refer to Helm's [documentation](https://helm.sh/docs/) to get started.
Once Helm is set up, add the repo:
```console
helm repo add ndustrial https://ndustrialio.github.io/charts
helm repo update
```
You can then run `helm search repo ndustrial` to see the charts.
### Required Values
All charts need the folowing fields defined:
```yaml
ndustrial:
## @param ndustrial.name The name of the application/service. (Required)
# Should match gitrepository name (if able)
name:
## @param ndustrial.organization The slug of the Organization that owns the application (Required)
organization:
## @param ndustrial.owner The person/team that owns this service. (Required)
owner:
## @param ndustrial.managed_by The service which manages the kubernetes object Should most likely be one of: helm, contxt, fleet. (Required)
managed_by:
## @param ndustrial.env The environment being deployed into Should most likely be one of: dev, staging, prod, or qa. (Required)
env:
## @param ndustrial.version The app version being deployed (Required)
version:
## @param ndustrial.repo The github repository where the code exists (populated by CI/CD)
repo:
## @param ndustrial.type The service type of this deployment (api, database, backend, frontend, etl, etc...) (Required)
type:
## @param ndustrial.project Unique project id that this repository belongs too (Required)
project:
## @param ndustrial.depends[0].project The name of the project that this service depends on
## @param ndustrial.depends[0].name The name of the project service
depends:
- project:
name:
```
If it is a `contxt` deployed chart the following values need to be defined:
```yaml
contxt:
## @param contxt.projectId The ID of the Contxt Stack that this object belongs to (if applicable)
projectId:
## @param contxt.serviceId The ID of the Contxt Service that this object belongs to (if applicable)
serviceId:
## @param contxt.serviceType The type of the Contxt Service that this object belongs to (if applicable)
serviceType:
```
## Charts
- [`common`](ndustrial/common/README.md) - common chart which provides helper functions for all charts
- [`cronjob`](ndustrial/cronjob/README.md) - chart to deploy `CronJob` resources
- [`deployment`](ndustrial/deployment/README.md) - chart to deploy `Deployment` resources
- [`statefulset`](ndustrial/statefulset/README.md) - chart to deploy `StatefulSet` resources
## CI/CD
We use GitHub Actions to test and release our charts. On a pull request, our [CI pipeline](./.github/workflows/ci.yaml) will lint and test any changes via Helm's [Chart Testing](https://github.com/helm/chart-testing#readme) tool. On a commit to master, our [Release pipeline](./.github/workflows/release.yaml) will package and release new charts to [GitHub Pages](https://pages.github.com/) via Helm's [Chart Releaser](https://github.com/helm/chart-releaser#readme).
## Development
All charts depend on the ndustrial [`common` chart](ndustrial/common/README.md).
### README Generator
Documentation is generated using [readme-generator-for-helm](https://github.com/bitnami-labs/readme-generator-for-helm) and can be ran via `make gen`.
### Lint Testing
Helm linting is done via Helm's [Chart Testing](https://github.com/helm/chart-testing#readme). This is ran via the CI pipeline but can be ran locally via docker with `make lint`.