|
1 | 1 | # prerender |
2 | 2 |
|
3 | | -TODO |
| 3 | +[Prerender](https://github.com/prerender/prerender) Prerender is a node server that uses |
| 4 | +Headless Chrome to render HTML, screenshots, PDFs, and HAR files out of any web page. |
| 5 | + |
| 6 | +## TL;DR |
| 7 | + |
| 8 | +```console |
| 9 | +$ helm repo add utkuozdemir https://utkuozdemir.org/helm-charts |
| 10 | +$ helm install my-release utkuozdemir/prerender |
| 11 | +``` |
| 12 | + |
| 13 | +## Introduction |
| 14 | + |
| 15 | +This Helm chart simply wraps the Docker image |
| 16 | +[tvanro/prerender-alpine](https://github.com/tvanro/prerender-alpine). |
| 17 | + |
| 18 | +## Prerequisites |
| 19 | + |
| 20 | +- Kubernetes 1.15+ |
| 21 | +- Helm 3.0+ |
| 22 | + |
| 23 | +## Installing the Chart |
| 24 | + |
| 25 | +To install the chart with the release name `my-release`: |
| 26 | + |
| 27 | +```console |
| 28 | +$ helm repo add utkuozdemir https://utkuozdemir.org/helm-charts |
| 29 | +$ helm install my-release utkuozdemir/prerender |
| 30 | +``` |
| 31 | + |
| 32 | +These commands deploy prerender in the default configuration. |
| 33 | +The [Parameters](#parameters) section lists the parameters |
| 34 | +that can be configured during installation. |
| 35 | + |
| 36 | +> **Tip**: List all releases using `helm list` |
| 37 | +
|
| 38 | +## Uninstalling the Chart |
| 39 | + |
| 40 | +To uninstall/delete the `my-release` release: |
| 41 | + |
| 42 | +```console |
| 43 | +$ helm delete my-release |
| 44 | +``` |
| 45 | + |
| 46 | +The command removes all the Kubernetes components associated with the chart and deletes the release. |
| 47 | + |
| 48 | +## Parameters |
| 49 | + |
| 50 | +| Key | Description | Default | |
| 51 | +|-----|------|---------| |
| 52 | +| `image.repository` | Image repository | `"prerender/prerender-single-process"` | |
| 53 | +| `image.pullPolicy` | Image pull policy | `"IfNotPresent"` | |
| 54 | +| `image.tag` | Image tag (if not specified, defaults to the chart's appVersion) | `""` | |
| 55 | +| `imagePullSecrets` | Image pull secrets | `[]` | |
| 56 | +| `nameOverride` | String to partially override prerender.fullname template with a string (will prepend the release name) | `""` | |
| 57 | +| `fullnameOverride` | String to fully override prerender.fullname template with a string | `""` | |
| 58 | +| `serviceAccount.create` | Create a service account | `true` | |
| 59 | +| `serviceAccount.annotations` | Annotations for the service account | `{}` | |
| 60 | +| `serviceAccount.name` | The name of the service account to create | `""` | |
| 61 | +| `service.type` | Type of the service | `"ClusterIP"` | |
| 62 | +| `service.annotations` | Annotations for the service | `{}` | |
| 63 | +| `ingress.enabled` | Enable the use of the ingress controller | `false` | |
| 64 | +| `ingress.annotations` | Annotations for the Ingress | `{}` | |
| 65 | +| `ingress.hosts[0].host` | Hostname to your installation | `chart-example.local` | |
| 66 | +| `ingress.hosts[0].paths` | Path within the url structure | `[]` | |
| 67 | +| `ingress.tls` | The TLS configuration for the ingress | `[]` | |
| 68 | +| `replicaCount` | Pod replica count (if autoscaling is not enabled) | `1` | |
| 69 | +| `autoscaling.enabled` | Enable autoscaling | `false` | |
| 70 | +| `autoscaling.minReplicas` | Minimum number of replicas when autoscaling is enabled | `1` | |
| 71 | +| `autoscaling.maxReplicas` | Maximum number of replicas when autoscaling is enabled | `10` | |
| 72 | +| `autoscaling.targetCPUUtilizationPercentage` | Target CPU utilization percentage when autoscaling is enabled | `80` | |
| 73 | +| `autoscaling.targetMemoryUtilizationPercentage` | Target memory utilization percentage when autoscaling is enabled | `nil` |
| 74 | +| `resources` | The resource requests and limits of the container | `{}` | |
| 75 | +| `podAnnotations` | Annotations for the pod | `{}` | |
| 76 | +| `podSecurityContext` | Security context for the pod | `{}` | |
| 77 | +| `securityContext` | Security context for the container | `{}` | |
| 78 | +| `nodeSelector` | The node selector for the deployment | `{}` | |
| 79 | +| `tolerations` | Tolerations for the pod assignment | `[]` | |
| 80 | +| `affinity` | Affinity for the pod assignment | `{}` | |
| 81 | +| `env` | The env variable key-value pairs to be passed to the pod | `{"NODE_ENV":"production"}` | |
| 82 | + |
| 83 | +The above config parameters map to the various configuration env variables of a typical prerender server. |
| 84 | + |
| 85 | +For more information please refer to the |
| 86 | +[project repository](https://github.com/prerender/prerender) |
| 87 | +and the [Docker image project repository](https://github.com/tvanro/prerender-alpine). |
| 88 | + |
| 89 | +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, |
| 90 | + |
| 91 | +```console |
| 92 | +helm install my-release \ |
| 93 | + --set env.CACHE_MAXSIZE=2000 \ |
| 94 | + utkuozdemir/prerender |
| 95 | +``` |
| 96 | + |
| 97 | +Alternatively, a YAML file that specifies the values for the above parameters |
| 98 | +can be provided while installing the chart. For example, |
| 99 | + |
| 100 | +```console |
| 101 | +helm install my-release -f values.yaml utkuozdemir/prerender |
| 102 | +``` |
| 103 | + |
| 104 | +> **Tip**: You can use the default [values.yaml](values.yaml) |
0 commit comments