README fixes, templating support, links now points to parca repos ins…

…tead of my personal repo

README.md

@@ -0,0 +1,12 @@
+## Helm charts for parca-server and parca-agent
+
+### Usage
+
+```console
+helm repo add parca https://parca-dev.github.io/helm-charts/
+helm repo update parca
+helm install my-parca parca/parca
+```
+
+### Contributing
+If you added, removed or adjusted helm values, please run [helm-docs](https://github.com/norwoodj/helm-docs) in charts/parca folder to re-generate README

charts/parca/Chart.yaml

@@ -6,7 +6,7 @@ home: https://parca.dev/
 icon: https://avatars.githubusercontent.com/u/86306284?s=200&v=4
 
 sources:
-  - https://github.com/rlex/helm-charts
+  - https://github.com/parca-dev/helm-charts
 # A chart can be either an 'application' or a 'library' chart.
 #
 # Application charts are a collection of templates that can be packaged into versioned archives
@@ -20,7 +20,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 1.6.1
+version: 1.6.2
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

charts/parca/README.md

@@ -1,17 +1,17 @@
 # parca
 
-Open Source Infrastructure-wide continuous profiling
+![Version: 1.6.1](https://img.shields.io/badge/Version-1.6.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.11.1](https://img.shields.io/badge/AppVersion-v0.11.1-informational?style=flat-square)
 
-**Homepage:** <https://parca.dev/>
+Open Source Infrastructure-wide continuous profiling
 
 ## Source Code
 
 * <https://github.com/parca-dev/helm-charts>
 
 ### Usage
 
-Please consult official docs on usage.  
-Chart includes prometheus-style discovery rule with annotations:  
+Please consult [official docs](https://www.parca.dev/docs/overview) on usage.
+Chart includes prometheus-style discovery rule with annotations:
 
 If you want k8s prometheus-like scraping for pprof endpoints, all you need is to add annotations for pod:
 ```
@@ -23,21 +23,29 @@ to furter adjust scope of scraping, you can use
 parca.dev/port: 'debug'
 ```
 
+## Chart Repo
+
+Add the following repo to use the chart:
+
+```console
+helm repo add parca https://parca-dev.github.io/helm-charts
+```
+
 ## Values
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | agent.enabled | bool | `true` | Allows disabling parca agent |
 | agent.image.pullPolicy | string | `"IfNotPresent"` | Overrides pullpolicy |
 | agent.image.repository | string | `"ghcr.io/parca-dev/parca-agent"` | Overrides the image repository |
-| agent.image.tag | string | `"v0.3.0"` | Overrides the image tag |
+| agent.image.tag | string | `"v0.8.0"` | Overrides the image tag |
 | agent.logLevel | string | `"info"` | Agent log level |
 | agent.nodeSelector | object | `{}` | node selector for scheduling agent pods |
 | agent.podAnnotations | object | `{}` | Additional annotations for pods |
 | agent.podLabelSelector | string | `""` | label selector for filtering out pods with pprof, ie "parca=enabled" |
 | agent.podSecurityContext | object | `{}` | Additional pod secutiry context |
 | agent.resources | object | `{}` | resource limits and requests |
-| agent.securityContext | object | `{"privileged":true}` | Security context, needs to be prilileged for ful functionality |
+| agent.securityContext | object | `{"privileged":true,"readOnlyRootFilesystem":true}` | Security context, needs to be prilileged for ful functionality |
 | agent.service.port | int | `7071` | service port for agent |
 | agent.service.type | string | `"ClusterIP"` | service type for agent |
 | agent.serviceMonitor.enabled | bool | `false` | enables prometheus servicemonitor for agent |
@@ -54,18 +62,18 @@ parca.dev/port: 'debug'
 | ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` |  |
 | ingress.tls | list | `[]` |  |
 | nameOverride | string | `""` | overrides chart name |
-| server.config | object | see values.yaml | parca server config block |
+| server.config | object | `{"debug_info":{"bucket":{"config":{"directory":"./tmp"},"type":"FILESYSTEM"},"cache":{"config":{"directory":"./tmp"},"type":"FILESYSTEM"}}}` | parca server config block |
 | server.corsAllowedOrigins | string | `"*"` | CORS setting |
 | server.image.pullPolicy | string | `"IfNotPresent"` | Overrides pull policy for server |
 | server.image.repository | string | `"ghcr.io/parca-dev/parca"` | Overrides the image repository for server |
-| server.image.tag | string | `"v0.6.1"` | Overrides the image tag for server |
+| server.image.tag | string | `"v0.11.1"` | Overrides the image tag for server |
 | server.logLevel | string | `"info"` | logging level of parca server |
 | server.nodeSelector | object | `{}` | node selector for scheduling server pod |
 | server.podAnnotations | object | `{}` | additional annotations for server pod |
 | server.podSecurityContext | object | `{}` | additional security context for server pod |
 | server.resources | object | `{}` | resource limits and requests for server pod |
 | server.retentionTime | string | `"6h"` | Sets retention period for server TSDB |
-| server.scrapeConfigs | list | see values.yaml | scrape configs for parca server |
+| server.scrapeConfigs | list | `[{"job_name":"kubernetes-pods","kubernetes_sd_configs":[{"role":"pod"}],"relabel_configs":[{"action":"keep","regex":true,"source_labels":["__meta_kubernetes_pod_annotation_parca_dev_scrape"]},{"action":"replace","regex":"(.+)","source_labels":["__meta_kubernetes_pod_annotation_parca_dev_path"],"target_label":"__metrics_path__"},{"action":"replace","regex":"([^:]+)(?::\\d+)?;(\\d+)","replacement":"$1:$2","source_labels":["__address__","__meta_kubernetes_pod_annotation_parca_dev_port"],"target_label":"__address__"},{"action":"labelmap","regex":"__meta_kubernetes_pod_label_(.+)"},{"action":"replace","source_labels":["__meta_kubernetes_namespace"],"target_label":"kubernetes_namespace"},{"action":"replace","source_labels":["__meta_kubernetes_pod_name"],"target_label":"kubernetes_pod_name"}],"scrape_interval":"1m","scrape_timeout":"10s"}]` | scrape configs for parca server |
 | server.securityContext | object | `{}` | additional security context for server |
 | server.service.port | int | `7070` | service port for server |
 | server.service.type | string | `"ClusterIP"` | service type for server |
@@ -76,5 +84,6 @@ parca.dev/port: 'debug'
 | serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
 | serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
 
-----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+## Upgrading
+
+A major chart version change indicates that there is an incompatible breaking change needing manual actions.

charts/parca/README.md.gotmpl

@@ -0,0 +1,38 @@
+{{ template "chart.header" . }}
+
+{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
+
+{{ template "chart.description" . }}
+
+{{ template "chart.sourcesSection" . }}
+
+{{ template "chart.requirementsSection" . }}
+
+### Usage
+
+Please consult [official docs](https://www.parca.dev/docs/overview) on usage.
+Chart includes prometheus-style discovery rule with annotations:
+
+If you want k8s prometheus-like scraping for pprof endpoints, all you need is to add annotations for pod:
+```
+parca.dev/scrape: 'true'
+```
+
+to furter adjust scope of scraping, you can use
+```
+parca.dev/port: 'debug'
+```
+
+## Chart Repo
+
+Add the following repo to use the chart:
+
+```console
+helm repo add parca https://parca-dev.github.io/helm-charts
+```
+
+{{ template "chart.valuesSection" . }}
+
+## Upgrading
+
+A major chart version change indicates that there is an incompatible breaking change needing manual actions.