Add the Chronicle Server chart

charts/_templates.gotmpl

@@ -8,6 +8,10 @@ R and Python packages that Data Scientists need to create and share data product
   {{- else if eq .Name "rstudio-workbench" -}}
 Data Scientists use [RStudio Workbench](https://www.rstudio.com/products/workbench/) to analyze data and create data
 products using R and Python.
+  {{- else if eq .Name "posit-chronicle" -}}
+Chronicle helps data science managers and other stakeholders understand their
+organization's use of other Posit products, primarily Posit Connect and
+Workbench.
   {{- end -}}
 {{- end }}
 
@@ -25,6 +29,8 @@ products using R and Python.
 # RStudio Package Manager
   {{- else if eq .Name "rstudio-workbench" -}}
 # RStudio Workbench
+  {{- else if eq .Name "posit-chronicle" -}}
+# Posit Chronicle
   {{- else -}}
 {{ template "chart.header" . }}
   {{- end }}

charts/posit-chronicle/.helmignore

@@ -0,0 +1,23 @@
+# 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
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

charts/posit-chronicle/Chart.yaml

@@ -0,0 +1,26 @@
+apiVersion: v2
+name: posit-chronicle
+description: Official Helm chart for Posit Chronicle Server
+version: 0.1.0
+appVersion: 2023.11.3
+icon: https://rstudio.com/wp-content/uploads/2018/10/RStudio-Logo-Flat.png
+home: https://www.posit.co
+sources:
+  - https://github.com/rstudio/helm
+maintainers:
+  - name: sol-eng
+    email: [email protected]
+    url: https://github.com/rstudio/helm
+annotations:
+  artifacthub.io/license: MIT
+  artifacthub.io/links: |
+    - name: Docker Images
+      url: https://github.com/rstudio/rstudio-docker-products
+    - name: Posit Community
+      url: https://community.rstudio.com/c/r-admin/5
+    - name: About Posit Team
+      url: https://posit.co/products/enterprise/team/
+keywords:
+  - "rstudio"
+  - "posit"
+  - "chronicle"

charts/posit-chronicle/LICENSE

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2023 Posit Software, PBC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

charts/posit-chronicle/Makefile

@@ -0,0 +1,14 @@
+lint:
+	helm lint --strict --set service.name=example --set service.version=0.0.1 -f ./ci/empty-values.yaml .
+	helm lint --strict --set service.name=example --set service.version=0.0.1 -f ./ci/simple-values.yaml .
+	helm lint --strict --set service.name=example --set service.version=0.0.1 -f ./ci/no-local-storage-values.yaml .
+	helm lint --strict --set service.name=example --set service.version=0.0.1 -f ./ci/complex-values.yaml .
+
+template:
+	helm template -f ci/complex-values.yaml . --debug
+
+template-all:
+	helm template -f ci/empty-values.yaml .
+	helm template -f ci/simple-values.yaml .
+	helm template -f ci/no-local-storage-values.yaml .
+	helm template -f ci/complex-values.yaml .

charts/posit-chronicle/NEWS.md

@@ -0,0 +1,4 @@
+# 0.1.0
+
+- Initial public release and integration into Posit's Helm repository. Includes
+  the new `posit-chronicle` chart, CI components, and documentation.

charts/posit-chronicle/README.md

@@ -0,0 +1,199 @@
+# Posit Chronicle
+
+![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![AppVersion: 2023.11.3](https://img.shields.io/badge/AppVersion-2023.11.3-informational?style=flat-square)
+
+#### _Official Helm chart for Posit Chronicle Server_
+
+Chronicle helps data science managers and other stakeholders understand their
+organization's use of other Posit products, primarily Posit Connect and
+Workbench.
+
+## For Production
+
+To ensure a stable production deployment, please:
+
+* Ensure you "pin" the version of the Helm chart that you are using. You can do
+  this using the `helm dependency` command and the associated "Chart.lock" files
+  or the `--version` flag. **IMPORTANT: This protects you from breaking changes**
+* Before upgrading, to avoid breaking changes, use `helm diff upgrade` to check
+  for breaking changes
+* Pay close attention to [`NEWS.md`](./NEWS.md) for updates on breaking
+  changes, as well as documentation below on how to use the chart
+
+## Installing the Chart
+
+To install the chart with the release name `my-release` at version 0.1.0:
+
+```bash
+helm repo add rstudio https://helm.rstudio.com
+helm upgrade --install my-release rstudio/posit-chronicle --version=0.1.0
+```
+
+To explore other chart versions, take a look at:
+```
+helm search repo rstudio/posit-chronicle -l
+```
+
+## Usage
+
+This chart deploys only the Chronicle server and is meant to be used in tandem
+with the Workbench and Connect charts. To actually send data to the server, you
+will need to run the Chronicle agent as a sidecar container on all of your
+Workbench or Connect server pods by setting `pod.sidecar` in their respective
+`values.yaml` files.
+
+Here is an example of Helm values to run the agent sidecar in Workbench:
+
+```yaml
+pod:
+  sidecar:
+    - name: chronicle-agent
+      image: posit-chronicle:2023.11.3
+      volumeMounts:
+      - name: CHRONICLE_PRODUCT_CLUSTER_ID
+        value: "posit-cluster-1"
+      - name: logs
+        mountPath: "/var/lib/rstudio-server/audit"
+      env:
+      - name: CHRONICLE_SERVER_ADDRESS
+        value: "http://chronicle-server.default.svc.cluster.local"
+```
+
+And here is an example of Helm values for Connect, where a Connect
+API key from a Kubernetes Secret is used to unlock more detailed metrics:
+
+```yaml
+pod:
+  sidecar:
+    - name: chronicle-agent
+      image: posit-chronicle:2023.11.3
+      env:
+      - name: CHRONICLE_PRODUCT_CLUSTER_ID
+        value: "posit-cluster-1"
+      - name: CHRONICLE_SERVER_ADDRESS
+        value: "http://chronicle-server.default.svc.cluster.local"
+      - name: CONNECT_API_KEY
+        valueFrom:
+          secretKeyRef:
+            name: connect
+            key: apikey
+```
+
+Note that it is up to the user to provision this Kubernetes Secret for the
+Connect API key.
+
+## Storage Configuration
+
+Chronicle can be configured to persist data to a local Kubernetes volume, AWS
+S3, or both.
+
+The default configuration uses a local volume, which is suitable if you'd like to
+access and analyze the data within your cluster:
+
+```yaml
+config:
+  LocalStorage:
+    Enabled: true
+    Location: "/chronicle-data"
+    RetentionPeriod: "30d"
+```
+
+`retentionPeriod` controls how long usage data are kept. For example, `"120m"`
+for 120 minutes, `"36h"` for 36 hours, `14d` for two weeks, or `"0"` for
+unbounded retention. (Units smaller than seconds or larger than days are not
+supported.)
+
+You can also persist data to AWS S3 instead of (or in addition to) local
+storage:
+
+```yaml
+config:
+  S3Storage:
+    Enabled: true
+    Bucket: "posit-chronicle"
+    Region: "us-east-2"
+```
+
+### Using Iam for S3
+
+If you are running on EKS, you can use [IAM Roles for Service
+Accounts](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html)
+to manage the credentials needed to access S3. In this scenario, once you have
+[created an IAM
+role](https://docs.aws.amazon.com/eks/latest/userguide/create-service-account-iam-policy-and-role.html),
+you can use this role as an annotation on the existing Service Account:
+
+```yaml
+serviceaccount:
+  create: true
+  annotations:
+    eks.amazonaws.com/role-arn:  arn:aws:iam::123456789000:role/iam-role-name-here
+```
+
+If you are unable to use IAM Roles for Service Accounts, there are any number of
+alternatives for injecting AWS credentials into a container. As a fallback,
+the S3 storage config allows specifying a profile:
+
+```yaml
+config:
+  S3Storage:
+    Enabled: true
+    Bucket: "posit-chronicle"
+    Profile: "my-aws-account"
+    Region: "us-east-2"
+```
+
+### Needed S3 Policy Permissions
+The credentials Chronicle uses for S3 storage must have the following permissions enabled:
+- `s3:GetObject`
+- `s3:ListBucket`
+- `s3:PutObject`
+- `s3:DeleteObject`
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| config.HTTPS.Certificate | string | `""` |  |
+| config.HTTPS.Enabled | bool | `false` |  |
+| config.HTTPS.Key | string | `""` |  |
+| config.LocalStorage.Enabled | bool | `true` |  |
+| config.LocalStorage.Location | string | `"./chronicle-data"` |  |
+| config.LocalStorage.RetentionPeriod | string | `"30d"` |  |
+| config.Logging.ServiceLog | string | `"STDOUT"` |  |
+| config.Logging.ServiceLogFormat | string | `"TEXT"` |  |
+| config.Logging.ServiceLogLevel | string | `"INFO"` |  |
+| config.Metrics.Enabled | bool | `true` |  |
+| config.Profiling.Enabled | bool | `false` |  |
+| config.S3Storage.Bucket | string | `"posit-chronicle"` |  |
+| config.S3Storage.Enabled | bool | `false` |  |
+| config.S3Storage.Prefix | string | `""` |  |
+| config.S3Storage.Profile | string | `""` |  |
+| config.S3Storage.Region | string | `"us-east-2"` |  |
+| image.imagePullPolicy | string | `"Always"` |  |
+| image.repository | string | `"ghcr.io/rstudio/chronicle"` |  |
+| image.tag | string | `"2023.11.3"` |  |
+| pod.affinity | object | `{}` | A map used verbatim as the pod's "affinity" definition |
+| pod.annotations | object | `{}` | Additional annotations to add to the chronicle-server pods |
+| pod.args[0] | string | `"start"` |  |
+| pod.args[1] | string | `"-c"` |  |
+| pod.args[2] | string | `"/etc/posit-chronicle/posit-chronicle.gcfg"` |  |
+| pod.command | string | `"/chronicle"` | The command and args to run in the chronicle-server container |
+| pod.env | list | `[]` | Optional environment variables |
+| pod.labels | object | `{}` | Additional labels to add to the chronicle-server pods |
+| pod.nodeSelector | object | `{}` | A map used verbatim as the pod's "nodeSelector" definition |
+| pod.selectorLabels | object | `{}` | Additional selector labels to add to the chronicle-server pods |
+| pod.tolerations | list | `[]` | An array used verbatim as the pod's "tolerations" definition |
+| replicas | int | `1` | The number of replica pods to maintain for this service |
+| service.annotations | object | `{}` | Additional annotations to add to the chronicle-server service |
+| service.labels | object | `{}` | Additional labels to add to the chronicle-server service |
+| service.port | int | `80` | The port to use for the REST service |
+| service.selectorLabels | object | `{}` | Additional selector labels to add to the chronicle-server service |
+| serviceaccount.annotations | object | `{}` | Additional annotations to add to the chronicle-server serviceaccount |
+| serviceaccount.create | bool | `false` |  |
+| serviceaccount.labels | object | `{}` | Additional labels to add to the chronicle-server serviceaccount |
+| storage.persistentVolumeSize | string | `"1Gi"` |  |
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+