Skip to content

Commit

Permalink
docs: add meta for sentry fields
Browse files Browse the repository at this point in the history
  • Loading branch information
@rohank-deepsource
rohank-deepsource committed Aug 29, 2023
1 parent eee255e commit ef6700f
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 18 deletions.
43 changes: 25 additions & 18 deletions charts/runner/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,29 @@

### Runner configuration Parameters

| Name | Description | Value |
| --------------------------------- | -------------------------------------------------------------- | ------- |
| `config.apps` | Configuration values for the VCS apps to be used by the runner | `[]` |
| `config.deepsource.host` | The host of the deepsource remote | `""` |
| `config.deepsource.publicKey` | The public key to use for the deepsource remote | `""` |
| `config.objectStorage.backend` | The backend to use for the object storage (e.g gcs) | `""` |
| `config.objectStorage.bucket` | The bucket to use for the object storage | `""` |
| `config.objectStorage.credential` | The credentials value to use for the object storage | `""` |
| `config.runner.id` | The id of the runner | `""` |
| `config.runner.host` | The host of the runner to use | `""` |
| `config.runner.clientId` | The client id to use for the runner | `""` |
| `config.runner.clientSecret` | The client secret to use for the runner | `""` |
| `config.runner.privateKey` | The private key to use for the runner | `""` |
| `config.runner.webhookSecret` | The webhook secret to use for the runner | `""` |
| `config.saml.enabled` | Whether to enable SAML2.0 authentication | `false` |
| `config.saml.certificate` | The certificate to use for the runner as service provider | `""` |
| `config.saml.key` | The private key to use for the runner as service provider | `""` |
| `config.saml.metadataUrl` | The metadata url to use for the identity provider | `""` |
| Name | Description | Value |
| ----------------------------------- | --------------------------------------------------------------------------- | ------- |
| `config.createSecret` | Whether to create a secret for the runner config | `true` |
| `config.secretName` | The name of the secret to use for the runner, if created externally | `""` |
| `config.apps` | Configuration values for the VCS apps to be used by the runner | `[]` |
| `config.deepsource.host` | The host of the deepsource remote | `""` |
| `config.deepsource.publicKey` | The public key to use for the deepsource remote | `""` |
| `config.objectStorage.createSecret` | Whether to create a secret for the object storage | `true` |
| `config.objectStorage.secretName` | The name of the secret to use for the object storage, if created externally | `""` |
| `config.objectStorage.provider` | The provider to use for the object storage (e.g gcs, s3) | `""` |
| `config.objectStorage.bucket` | The bucket to use for the object storage | `""` |
| `config.objectStorage.credential` | The credentials value to use for the object storage | `""` |
| `config.runner.id` | The id of the runner | `""` |
| `config.runner.host` | The host of the runner to use | `""` |
| `config.runner.clientId` | The client id to use for the runner | `""` |
| `config.runner.clientSecret` | The client secret to use for the runner | `""` |
| `config.runner.privateKey` | The private key to use for the runner | `""` |
| `config.runner.webhookSecret` | The webhook secret to use for the runner | `""` |
| `config.saml.enabled` | Whether to enable SAML2.0 authentication | `false` |
| `config.saml.certificate` | The certificate to use for the runner as service provider | `""` |
| `config.saml.key` | The private key to use for the runner as service provider | `""` |
| `config.saml.metadataUrl` | The metadata url to use for the identity provider | `""` |
| `config.sentry.dsn` | The DSN to use for the sentry integration | `""` |

### Common Parameters

Expand All @@ -29,6 +34,8 @@
| `image.repository` | deepsource runner image repository | `proxy.deepsource.com/images/deepsource-production/runner` |
| `image.pullPolicy` | deepsource runner image pull policy | `Always` |
| `image.tag` | deepsource runner image tag | `""` |
| `imageRegistry.createSecret` | Whether to create a secret for the image registry | `true` |
| `imageRegistry.secretName` | The name of the secret to use for the image registry, if created externally | `""` |
| `imageRegistry.registryUrl` | The registry url to use for the task images | `""` |
| `imageRegistry.username` | The username to use for the image registry | `""` |
| `imageRegistry.password` | The password to use for the image registry | `""` |
Expand Down
16 changes: 16 additions & 0 deletions charts/runner/values.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
## The configuration values for deepsource runner, this will create a secret to be used by the runner
##
config:
## @param config.createSecret Whether to create a secret for the runner config
##
createSecret: true
## @param config.secretName The name of the secret to use for the runner, if created externally
##
secretName: ""
## @param config.apps Configuration values for the VCS apps to be used by the runner
## apps:
Expand All @@ -31,7 +35,11 @@ config:
## Configuration values for the object storage to use for the runner
##
objectStorage:
## @param config.objectStorage.createSecret Whether to create a secret for the object storage
##
createSecret: true
## @param config.objectStorage.secretName The name of the secret to use for the object storage, if created externally
##
secretName: ""
## @param config.objectStorage.provider The provider to use for the object storage (e.g gcs, s3)
##
Expand Down Expand Up @@ -77,6 +85,12 @@ config:
key: ""
## @param config.saml.metadataUrl The metadata url to use for the identity provider
metadataUrl: ""
## Configuration values for the sentry integration
##
sentry:
## @param config.sentry.dsn The DSN to use for the sentry integration
##
dsn: ""

## @section Common Parameters
##
Expand All @@ -96,6 +110,8 @@ image:
tag: ""

## Deepsource runner image registry configuration
## @param imageRegistry.createSecret Whether to create a secret for the image registry
## @param imageRegistry.secretName The name of the secret to use for the image registry, if created externally
## @param imageRegistry.registryUrl The registry url to use for the task images
## @param imageRegistry.username The username to use for the image registry
## @param imageRegistry.password The password to use for the image registry
Expand Down

0 comments on commit ef6700f

Please sign in to comment.