Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Jordan Hoeft committed Feb 6, 2024
1 parent 759e63e commit 1655f48
Show file tree
Hide file tree
Showing 5 changed files with 65 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

Welcome to the repository containing Helm charts for deploying TSM Builder Vault services on Kubernetes.

## Helm Repository

```
helm repo add builder-vault https://blockdaemon.github.io/builder-vault-helm/
helm repo update
```

## TSM Node Chart

For deploying a TSM node, you can find the specific Helm chart and its documentation in the `charts/tsm-node` directory. The README in that directory provides detailed information on how to configure and install the TSM node chart.
Expand Down
7 changes: 7 additions & 0 deletions examples/tsm-node-multiinstance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ This directory has an example of deploying a multi instance TSM cluster with the

Full documentation of the configuration can be found [here](https://builder-vault-tsm.docs.blockdaemon.com/docs/example-tsm-configuration-file).

## Helm Repository

```
helm repo add builder-vault https://blockdaemon.github.io/builder-vault-helm/
helm repo update
```

## Prerequisites
- An EKS cluster deployed with the [AWS Loadbalancer Controller](https://docs.aws.amazon.com/eks/latest/userguide/aws-load-balancer-controller.html) installed and configured.

Expand Down
17 changes: 17 additions & 0 deletions examples/tsm-node-multiinstance/tsm0.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,23 @@ config:
[MultiInstance]
CleanupInterval = "5m"
CleanupProbability = 75
[Audit]
# URL of the audit receiver. Audit logs are sent to this URL
# Can be a file, HTTP location or s3 location: file://, https://, s3://
#ReceiverURL = ""
# When using an S3-compatible API as the ReceiverURL in [Audit], specify any
# non-standard S3 related parameters here
[Audit.S3EndpointConfig]
# If not using the default S3 endpoint, specify the custom one here
#EndpointURL = ""
# AWS or S3-compatible API region
#Region = ""
# Authorization keys for the S3-compatible API
#SecretAccessKey = ""
#AccessKeyId = ""
#SessionToken = ""
image:
repository: <the name of the repository where tsm-node is stored>
Expand Down
17 changes: 17 additions & 0 deletions examples/tsm-node-multiinstance/tsm1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,23 @@ config:
CleanupInterval = "5m"
CleanupProbability = 75
[Audit]
# URL of the audit receiver. Audit logs are sent to this URL
# Can be a file, HTTP location or s3 location: file://, https://, s3://
#ReceiverURL = ""
# When using an S3-compatible API as the ReceiverURL in [Audit], specify any
# non-standard S3 related parameters here
[Audit.S3EndpointConfig]
# If not using the default S3 endpoint, specify the custom one here
#EndpointURL = ""
# AWS or S3-compatible API region
#Region = ""
# Authorization keys for the S3-compatible API
#SecretAccessKey = ""
#AccessKeyId = ""
#SessionToken = ""
image:
repository: <the name of the repository where tsm-node is stored>
pullPolicy: IfNotPresent
Expand Down
17 changes: 17 additions & 0 deletions examples/tsm-node-multiinstance/tsm2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,23 @@ config:
CleanupInterval = "5m"
CleanupProbability = 75
[Audit]
# URL of the audit receiver. Audit logs are sent to this URL
# Can be a file, HTTP location or s3 location: file://, https://, s3://
#ReceiverURL = ""
# When using an S3-compatible API as the ReceiverURL in [Audit], specify any
# non-standard S3 related parameters here
[Audit.S3EndpointConfig]
# If not using the default S3 endpoint, specify the custom one here
#EndpointURL = ""
# AWS or S3-compatible API region
#Region = ""
# Authorization keys for the S3-compatible API
#SecretAccessKey = ""
#AccessKeyId = ""
#SessionToken = ""
image:
repository: <the name of the repository where tsm-node is stored>
pullPolicy: IfNotPresent
Expand Down

0 comments on commit 1655f48

Please sign in to comment.