diff --git a/charts/octoprint/Chart.yaml b/charts/octoprint/Chart.yaml new file mode 100644 index 00000000..caa6c48f --- /dev/null +++ b/charts/octoprint/Chart.yaml @@ -0,0 +1,21 @@ +apiVersion: v2 +appVersion: 1.4.2 +description: OctoPrint is the snappy web interface for your 3D printer +name: octoprint +version: 1.0.0 +keywords: + - octoprint + - 3d + - printer +home: https://github.com/k8s-at-home/charts/tree/master/charts/octoprint +icon: https://avatars3.githubusercontent.com/u/5982294?s=400&v=4 +sources: + - https://github.com/OctoPrint/OctoPrint + - https://hub.docker.com/r/octoprint/octoprint +maintainers: + - name: billimek + email: jeff@billimek.com +dependencies: + - name: common + repository: https://k8s-at-home.com/charts/ + version: 1.7.0 diff --git a/charts/octoprint/OWNERS b/charts/octoprint/OWNERS new file mode 100644 index 00000000..1ce35762 --- /dev/null +++ b/charts/octoprint/OWNERS @@ -0,0 +1,8 @@ +approvers: +- billimek +- onedr0p +- bjw-s +reviewers: +- billimek +- onedr0p +- bjw-s diff --git a/charts/octoprint/README.md b/charts/octoprint/README.md new file mode 100644 index 00000000..27085967 --- /dev/null +++ b/charts/octoprint/README.md @@ -0,0 +1,63 @@ +# Octoprint + +This is a helm chart for [Octoprint](https://github.com/OctoPrint/OctoPrint). + +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** + +## TL;DR; + +```shell +$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ +$ helm install k8s-at-home/octoprint +``` + +## Installing the Chart + +To install the chart with the release name `my-release`: + +```console +helm install --name my-release k8s-at-home/octoprint +``` + +## Uninstalling the Chart + +To uninstall/delete the `my-release` deployment: + +```console +helm delete my-release --purge +``` + +The command removes all the Kubernetes components associated with the chart and deletes the release. + +## Configuration +Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/octoprint/values.yaml) +file. It has several commented out suggested values. +Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +```console +helm install octoprint \ + --set env.TZ="America/New_York" \ + k8s-at-home/octoprint +``` +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the +chart. For example, +```console +helm install octoprint k8s-at-home/octoprint --values values.yaml +``` + +```yaml +image: + tag: ... +``` + +--- +**NOTE** + +If you get +```console +Error: rendered manifests contain a resource that already exists. Unable to continue with install: existing resource conflict: ...` +``` +it may be because you uninstalled the chart with `skipuninstall` enabled, you need to manually delete the pvc or use `existingClaim`. + +--- diff --git a/charts/octoprint/ci/ct-values.yaml b/charts/octoprint/ci/ct-values.yaml new file mode 100644 index 00000000..f6ccc628 --- /dev/null +++ b/charts/octoprint/ci/ct-values.yaml @@ -0,0 +1,2 @@ +ingress: + enabled: true diff --git a/charts/octoprint/templates/NOTES.txt b/charts/octoprint/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/octoprint/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/octoprint/templates/common.yaml b/charts/octoprint/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/octoprint/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/octoprint/values.yaml b/charts/octoprint/values.yaml new file mode 100644 index 00000000..751a9c9f --- /dev/null +++ b/charts/octoprint/values.yaml @@ -0,0 +1,38 @@ +# Default values for Octoprint. + +image: + repository: octoprint/octoprint + pullPolicy: IfNotPresent + tag: 1.4.2 + +strategy: + type: Recreate + +securityContext: + privileged: true + +service: + port: + port: 5000 + +env: + OCTOPRINT_PORT: "5000" + # TZ: UTC + # CAMERA_DEV: /dev/video0 + +persistence: + data: + enabled: false + emptyDir: false + mountPath: /home/octoprint/.octoprint + +# Paths to your 3D printer and/or camera in the container +additionalVolumeMounts: + - name: printer + mountPath: /dev/ttyACM0 + +# Paths to your 3D printer and/or camera on the host +additionalVolumes: + - name: printer + hostPath: + path: /dev/ttyACM0