diff --git a/charts/stable/puppeteer/.helmignore b/charts/stable/puppeteer/.helmignore new file mode 100644 index 00000000..4379e2b3 --- /dev/null +++ b/charts/stable/puppeteer/.helmignore @@ -0,0 +1,26 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl diff --git a/charts/stable/puppeteer/Chart.yaml b/charts/stable/puppeteer/Chart.yaml new file mode 100644 index 00000000..e339c3f9 --- /dev/null +++ b/charts/stable/puppeteer/Chart.yaml @@ -0,0 +1,27 @@ +apiVersion: v2 +appVersion: v13.3.2 +description: Headless Chrome Node.js API +name: puppeteer +version: 1.0.0 +kubeVersion: ">=1.16.0-0" +keywords: + - puppeteer + - headless chrome + - nodejs + - dev-tools +home: https://github.com/k8s-at-home/charts/tree/master/charts/stable/puppeteer +icon: https://avatars.githubusercontent.com/u/6906516?s=200&v=4 +sources: + - https://github.com/jr0dd/container-images/tree/main/apps/puppeteer + - https://github.com/puppeteer/puppeteer +maintainers: + - name: jr0dd + email: j_r0dd@icloud.com +dependencies: + - name: common + repository: https://library-charts.k8s-at-home.com + version: 4.3.0 +annotations: + artifacthub.io/changes: | + - kind: changed + description: Upgraded `common` chart dependency to version `4.3.0`. diff --git a/charts/stable/puppeteer/README.md b/charts/stable/puppeteer/README.md new file mode 100644 index 00000000..0a7a0162 --- /dev/null +++ b/charts/stable/puppeteer/README.md @@ -0,0 +1,111 @@ +# ${CHARTNAME} + +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) + +${CHARTNAME} helm package + +**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)** + +## Source Code + +* + +## Requirements + +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://library-charts.k8s-at-home.com | common | 4.0.0 | + +## TL;DR + +```console +helm repo add k8s-at-home https://k8s-at-home.com/charts/ +helm repo update +helm install ${CHARTNAME} k8s-at-home/${CHARTNAME} +``` + +## Installing the Chart + +To install the chart with the release name `${CHARTNAME}` + +```console +helm install ${CHARTNAME} k8s-at-home/${CHARTNAME} +``` + +## Uninstalling the Chart + +To uninstall the `${CHARTNAME}` deployment + +```console +helm uninstall ${CHARTNAME} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. + +## Configuration + +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common). + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install ${CHARTNAME} \ + --set env.TZ="America/New York" \ + k8s-at-home/${CHARTNAME} +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install ${CHARTNAME} k8s-at-home/${CHARTNAME} -f values.yaml +``` + +## Custom configuration + +N/A + +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common) + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| env | object | See below | environment variables. See more environment variables in the [${CHARTNAME} documentation](https://${CHARTNAME}.org/docs). | +| env.TZ | string | `"UTC"` | Set the container timezone | +| image.pullPolicy | string | `"IfNotPresent"` | image pull policy | +| image.repository | string | `"${CHARTNAME}/${CHARTNAME}"` | image repository | +| image.tag | string | `"1.0.0"` | image tag | +| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. | +| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. | +| service | object | See values.yaml | Configures service settings for the chart. | + +## Changelog + +### Version 1.0.0 + +#### Added + +- Initial version + +#### Changed + +N/A + +#### Fixed + +N/A + +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/charts/stable/puppeteer/README.md.gotmpl b/charts/stable/puppeteer/README.md.gotmpl new file mode 100644 index 00000000..94f7808a --- /dev/null +++ b/charts/stable/puppeteer/README.md.gotmpl @@ -0,0 +1,176 @@ +{{- define "custom.repository.organization" -}} +k8s-at-home +{{- end -}} + +{{- define "custom.repository.url" -}} +https://github.com/k8s-at-home/charts +{{- end -}} + +{{- define "custom.helm.url" -}} +https://k8s-at-home.com/charts/ +{{- end -}} + +{{- define "custom.helm.path" -}} +{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }} +{{- end -}} + +{{- define "custom.notes" -}} +**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)** +{{- end -}} + +{{- define "custom.requirements" -}} +## Requirements + +{{ template "chart.kubeVersionLine" . }} +{{- end -}} + +{{- define "custom.dependencies" -}} +## Dependencies + +{{ template "chart.requirementsTable" . }} +{{- end -}} + +{{- define "custom.install.tldr" -}} +## TL;DR + +```console +helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }} +helm repo update +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.install" -}} +## Installing the Chart + +To install the chart with the release name `{{ template "chart.name" . }}` + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.uninstall" -}} +## Uninstalling the Chart + +To uninstall the `{{ template "chart.name" . }}` deployment + +```console +helm uninstall {{ template "chart.name" . }} +``` + +The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. +{{- end -}} + +{{- define "custom.configuration.header" -}} +## Configuration +{{- end -}} + +{{- define "custom.configuration.readValues" -}} +Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values. +Other values may be used from the [values.yaml](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common). +{{- end -}} + +{{- define "custom.configuration.example.set" -}} +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +```console +helm install {{ template "chart.name" . }} \ + --set env.TZ="America/New York" \ + {{ template "custom.helm.path" . }} +``` +{{- end -}} + +{{- define "custom.configuration.example.file" -}} +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. + +```console +helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml +``` +{{- end -}} + +{{- define "custom.valuesSection" -}} +## Values + +**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common) + +{{ template "chart.valuesTable" . }} +{{- end -}} + +{{- define "custom.support" -}} +## Support + +- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) +- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose) +- Ask a [question](https://github.com/k8s-at-home/organization/discussions) +- Join our [Discord](https://discord.gg/sTMX7Vh) community +{{- end -}} + +{{- define "custom.changelog" -}} +{{ $changeTypes := list "added" "changed" "fixed" }} +## Changelog + +### Version {{ template "chart.version" . }} + +{{ range $changeType := $changeTypes }} + {{- with (index $.Annotations "artifacthub.io/changes") }} + {{- print "#### " ($changeType | title) | nindent 0 }} + {{- print "" | nindent 0 }} + {{- $changesFound := false }} + {{- range (print "changes:\n" . | fromYaml).changes }} + {{- if eq .kind $changeType }} + {{- print "* " .description | nindent 0 }} + {{- $changesFound = true }} + {{- end }} + {{- end }} + {{- if not $changesFound }} + {{- print "N/A" | nindent 0 }} + {{- end }} + {{- print "" | nindent 0 }} + {{- end }} +{{- end }} + +### Older versions + +A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/k8s-at-home/{{- template "chart.name" . }}?modal=changelog) + +{{- end -}} + +{{ template "chart.header" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }} + +{{ template "custom.notes" . }} + +{{ template "chart.sourcesSection" . }} + +{{ template "custom.requirements" . }} + +{{ template "custom.dependencies" . }} + +{{ template "custom.install.tldr" . }} + +{{ template "custom.install" . }} + +{{ template "custom.uninstall" . }} + +{{ template "custom.configuration.header" . }} + +{{ template "custom.configuration.readValues" . }} + +{{ template "custom.configuration.example.set" . }} + +{{ template "custom.configuration.example.file" . }} + +{{ template "custom.custom.configuration" . }} + +{{ template "custom.valuesSection" . }} + +{{ template "custom.changelog" . }} + +{{ template "custom.support" . }} + +{{ template "helm-docs.versionFooter" . }} +{{ "" }} diff --git a/charts/stable/puppeteer/README_CONFIG.md.gotmpl b/charts/stable/puppeteer/README_CONFIG.md.gotmpl new file mode 100644 index 00000000..65e23b3e --- /dev/null +++ b/charts/stable/puppeteer/README_CONFIG.md.gotmpl @@ -0,0 +1,32 @@ +{{- define "custom.custom.configuration.header" -}} +## Sample code to connect to Puppeteer +{{- end -}} + +{{- define "custom.custom.configuration" -}} +{{ template "custom.custom.configuration.header" . }} + +``` +const puppeteer = require('puppeteer-core') +const dns = require('dns').promises; + +(async () => { + // these dns options are not needed if using an load balancer or ingress + const options = { + family: 4, + hints: dns.ADDRCONFIG | dns.V4MAPPED + } + const { address: host } = await dns.lookup('puppeteer', options, (address) => { + return address + }) + const browser = await puppeteer.connect({ + browserURL: `http://${host}:4000` + }) + const page = await browser.newPage() + await page.goto('https://example.com', { waitUntil: 'networkidle0' }) + await page.close() + .catch((err) => { + console.error(err) + }) +})() +``` +{{- end -}} diff --git a/charts/stable/puppeteer/templates/NOTES.txt b/charts/stable/puppeteer/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/stable/puppeteer/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/stable/puppeteer/templates/common.yaml b/charts/stable/puppeteer/templates/common.yaml new file mode 100644 index 00000000..e619438a --- /dev/null +++ b/charts/stable/puppeteer/templates/common.yaml @@ -0,0 +1,30 @@ +{{/* Make sure all variables are set properly */}} +{{- include "common.values.setup" . }} + +{{/* Append the hardcoded settings */}} +{{- define "puppeteer.hardcodedValues" -}} +{{- $primaryService := get .Values.service (include "common.service.primary" .) -}} +{{- $defaultServicePort := get $primaryService.ports (include "common.classes.service.ports.primary" (dict "values" $primaryService)) -}} +command: + - node + - server.js +args: + {{ with .Values.chromium.args }} + {{ range . }} + - {{ . }} + {{ end }} + {{ end }} + - --remote-debugging-port={{ $defaultServicePort.port }} +probes: + liveness: + enabled: true + custom: true + spec: + httpGet: + path: /json/list + port: {{ $defaultServicePort.port }} +{{- end -}} +{{- $_ := mergeOverwrite .Values (include "puppeteer.hardcodedValues" . | fromYaml) -}} + +{{/* Render the templates */}} +{{ include "common.all" . }} diff --git a/charts/stable/puppeteer/values.yaml b/charts/stable/puppeteer/values.yaml new file mode 100644 index 00000000..c309d213 --- /dev/null +++ b/charts/stable/puppeteer/values.yaml @@ -0,0 +1,53 @@ +# +# IMPORTANT NOTE +# +# This chart inherits from our common library chart. You can check the default values/options here: +# https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml +# + +image: + # -- image repository + repository: ghcr.io/jr0dd/puppeteer + # -- image pull policy + pullPolicy: IfNotPresent + # -- image tag + tag: v13.3.2 + +chromium: + # -- chromium args. You can find more chromium expiremental flags [chromium switches](https://peter.sh/experiments/chromium-command-line-switches/). + # @default -- See below + args: + # disable gpu functions + - '--disable-gpu' + - '--disable-software-rasterizer' + - '--no-zygote' + # cors handling + - '--disable-features=IsolateOrigins,site-per-process' + - '--disable-site-isolation-trials' + - '--disable-web-security' + +# -- environment variables. See more environment variables in the [puppeteer documentation](https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#environment-variables). +# @default -- See below +env: + # -- Set the container timezone + TZ: UTC + +# -- Configures service settings for the chart. +# @default -- See values.yaml +service: + main: + ports: + http: + port: 4000 + +# -- Configure persistence settings for the chart under this key. +# @default -- See values.yaml +persistence: + config: + enabled: false + +ingress: + # -- Enable and configure ingress settings for the chart under this key. + # @default -- See values.yaml + main: + enabled: false