diff --git a/charts/stable/puppeteer/README.md b/charts/stable/puppeteer/README.md index 0a7a0162..71b52bd3 100644 --- a/charts/stable/puppeteer/README.md +++ b/charts/stable/puppeteer/README.md @@ -1,14 +1,15 @@ -# ${CHARTNAME} +# puppeteer -![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) +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: v13.3.2](https://img.shields.io/badge/AppVersion-v13.3.2-informational?style=flat-square) -${CHARTNAME} helm package +Headless Chrome Node.js API **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 @@ -18,30 +19,30 @@ Kubernetes: `>=1.16.0-0` | Repository | Name | Version | |------------|------|---------| -| https://library-charts.k8s-at-home.com | common | 4.0.0 | +| https://library-charts.k8s-at-home.com | common | 4.3.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} +helm install puppeteer k8s-at-home/puppeteer ``` ## Installing the Chart -To install the chart with the release name `${CHARTNAME}` +To install the chart with the release name `puppeteer` ```console -helm install ${CHARTNAME} k8s-at-home/${CHARTNAME} +helm install puppeteer k8s-at-home/puppeteer ``` ## Uninstalling the Chart -To uninstall the `${CHARTNAME}` deployment +To uninstall the `puppeteer` deployment ```console -helm uninstall ${CHARTNAME} +helm uninstall puppeteer ``` The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release. @@ -54,20 +55,43 @@ Other values may be used from the [values.yaml](https://github.com/k8s-at-home/l Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. ```console -helm install ${CHARTNAME} \ +helm install puppeteer \ --set env.TZ="America/New York" \ - k8s-at-home/${CHARTNAME} + k8s-at-home/puppeteer ``` 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 +helm install puppeteer k8s-at-home/puppeteer -f values.yaml ``` -## Custom configuration +## Sample code to connect to Puppeteer -N/A +``` +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) + }) +})() +``` ## Values @@ -75,11 +99,12 @@ N/A | Key | Type | Default | Description | |-----|------|---------|-------------| -| env | object | See below | environment variables. See more environment variables in the [${CHARTNAME} documentation](https://${CHARTNAME}.org/docs). | +| chromium.args | list | See below | chromium args. You can find more chromium expiremental flags [chromium switches](https://peter.sh/experiments/chromium-command-line-switches/). | +| env | object | See below | environment variables. See more environment variables in the [puppeteer documentation](https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#environment-variables). | | 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 | +| image.repository | string | `"ghcr.io/jr0dd/puppeteer"` | image repository | +| image.tag | string | `"v13.3.2"` | 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. | @@ -90,16 +115,20 @@ N/A #### Added -- Initial version +N/A #### Changed -N/A +* Upgraded `common` chart dependency to version `4.3.0`. #### Fixed N/A +### Older versions + +A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/k8s-at-home/puppeteer?modal=changelog) + ## Support - See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) @@ -108,4 +137,4 @@ N/A - 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) +Autogenerated from chart metadata using [helm-docs v0.1.1](https://github.com/k8s-at-home/helm-docs/releases/v0.1.1)