Summary
Develop Helm charts to facilitate deployment of both node and router services to Kubernetes clusters.
Requirements
- Add a
charts/ directory containing the Helm chart for this project.
- The Helm chart must:
- Permit configuration of container image repository, tag, and pull policy.
- Allow configuration of resource requests/limits.
- Allow setting environment variables through
values.yaml.
- Include support for secrets and configmaps.
- Permit replica count settings.
- Provide readiness and liveness probes.
- Document all available configuration options in
values.yaml.
- Add documentation to the README covering installation, upgrades, and configuration via Helm.
Example Chart Layout
charts/
commonware-avs-service/
Chart.yaml
values.yaml
templates/
deployment.yaml
service.yaml
ingress.yaml
configmap.yaml
secrets.yaml
Example values.yaml
image:
repository: ghcr.io/breadchaincoop/commonware-avs-service
tag: "latest"
pullPolicy: IfNotPresent
replicaCount: 1
service:
type: ClusterIP
port: 80
ingress:
enabled: false
annotations: {}
hosts:
- host: chart-example.local
paths: ["/"]
resources: {}
env: {}
Installation Example
helm install my-service charts/commonware-avs-service -f custom-values.yaml
Additional Guidance
- Follow Helm best practices for structure and maintainability.
- Ensure charts are production-ready and secure.
- Consider listing the chart on Artifact Hub.
Summary
Develop Helm charts to facilitate deployment of both
nodeandrouterservices to Kubernetes clusters.Requirements
charts/directory containing the Helm chart for this project.values.yaml.values.yaml.Example Chart Layout
Example
values.yamlInstallation Example
Additional Guidance