diff --git a/charts/posit-chronicle/README.md b/charts/posit-chronicle/README.md index dbfddfbf..9b6647ef 100644 --- a/charts/posit-chronicle/README.md +++ b/charts/posit-chronicle/README.md @@ -38,9 +38,8 @@ helm search repo rstudio/posit-chronicle -l 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. +will need to run the Chronicle agent as a sidecar container on 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: @@ -84,8 +83,7 @@ Connect API key. ## Storage Configuration -Chronicle can be configured to persist data to a local Kubernetes volume, AWS -S3, or both. +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: @@ -99,9 +97,8 @@ config: ``` `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.) +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: @@ -118,8 +115,7 @@ config: 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 +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: @@ -196,5 +192,5 @@ The credentials Chronicle uses for S3 storage must have the following permission | storage.persistentVolumeSize | string | `"1Gi"` | | ---------------------------------------------- -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 v1.11.3](https://github.com/norwoodj/helm-docs/releases/v1.11.3) diff --git a/charts/posit-chronicle/README.md.gotmpl b/charts/posit-chronicle/README.md.gotmpl index 64f809d0..53ce6a25 100644 --- a/charts/posit-chronicle/README.md.gotmpl +++ b/charts/posit-chronicle/README.md.gotmpl @@ -12,9 +12,8 @@ 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. +will need to run the Chronicle agent as a sidecar container on 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: @@ -58,8 +57,7 @@ Connect API key. ## Storage Configuration -Chronicle can be configured to persist data to a local Kubernetes volume, AWS -S3, or both. +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: @@ -73,9 +71,8 @@ config: ``` `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.) +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: @@ -92,8 +89,7 @@ config: 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 +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: