Skip to content

Commit

Permalink
improve chronicle docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@AlexMapley
AlexMapley committed Dec 5, 2023
1 parent c5a8461 commit 3e1eafe
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 21 deletions.
18 changes: 7 additions & 11 deletions charts/posit-chronicle/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -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:

Expand Down Expand Up @@ -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)

16 changes: 6 additions & 10 deletions charts/posit-chronicle/README.md.gotmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -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:

Expand Down

0 comments on commit 3e1eafe

Please sign in to comment.