Skip to content

Commit

Permalink
Merge pull request #10 from sorry-cypress/add-configuration-section-t…
Browse files Browse the repository at this point in the history 
…o-readme

Add configuration section to README
  • Loading branch information
@fsmaia
fsmaia authored Jan 12, 2021
2 parents 62c9354 + fd5bba8 commit daa0dec
Showing 1 changed file with 84 additions and 0 deletions.
84 changes: 84 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,16 @@
$ helm repo add sorry-cypress https://sorry-cypress.github.io/charts
$ helm repo update
```

_See [helm repo](https://helm.sh/docs/helm/helm_repo/) for command documentation._

## Install Chart

```console
# Helm 3
$ helm install [RELEASE_NAME] sorry-cypress/sorry-cypress [flags]
```

_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._

## Uninstall Chart
Expand All @@ -30,6 +33,7 @@ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documen
# Helm 3
$ helm uninstall [RELEASE_NAME]
```

This removes all the Kubernetes components associated with the chart and deletes the release.

_See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._
Expand All @@ -42,4 +46,84 @@ Upgrade the chart deployment using:
# Helm 3
$ helm upgrade [RELEASE_NAME] sorry-cypress/sorry-cypress [flags]
```

_See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._

## Configuration

The following table lists the configurable parameters of the sorry-cypress chart and their default values.

### API service

https://sorry-cypress.dev/api#configuration

| Parameter | Description | Default |
| --------------------------- | ------------------------------------- | --------------------------- |
| `api.image.repository` | Image repository | `agoldis/sorry-cypress-api` |
| `api.image.tag` | Image tag | `latest` |
| `api.image.pullPolicy` | Image pull policy | `Always` |
| `api.resources` | Resources to initialize the container | `{}` |
| `api.service.port` | Kubernetes service port | `4000` |
| `api.ingress.annotations` | Ingress annotations | `{}` |
| `api.ingress.hosts[0].host` | Hostname to the service installation | `api.chart-example.local` |
| `api.ingress.tls` | Ingress secrets for TLS certificates | `[]` |

### Dashboard service

https://sorry-cypress.dev/dashboard#configuration

| Parameter | Description | Default |
| ------------------------------------------------- | ------------------------------------------------------------------------------ | --------------------------------- |
| `dashboard.image.repository` | Image repository | `agoldis/sorry-cypress-dashboard` |
| `dashboard.image.tag` | Image tag | `latest` |
| `dashboard.image.pullPolicy` | Image pull policy | `Always` |
| `dashboard.resources` | Resources to initialize the container | `{}` |
| `dashboard.environmentVariables.ciUrl` | Set optional environment variable `CI_URL` to add a link to your CI tool | `""` |
| `dashboard.environmentVariables.graphQlSchemaUrl` | Set the environment variable `GRAPHQL_SCHEMA_URL` with the URL of API service. | `""` |
| `dashboard.service.port` | Kubernetes service port | `4000` |
| `dashboard.ingress.enabled` | Flag to define if the dashboard service ingress is enabled | `true` |
| `dashboard.ingress.annotations` | Ingress annotations | `{}` |
| `dashboard.ingress.hosts[0].host` | Hostname to the service installation | `dashboard.chart-example.local` |
| `dashboard.ingress.tls` | Ingress secrets for TLS certificates | `[]` |

### Director service

https://sorry-cypress.dev/director/configuration

| Parameter | Description | Default |
| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
| `director.image.repository` | Image repository | `agoldis/sorry-cypress-director` |
| `director.image.tag` | Image tag | `latest` |
| `director.image.pullPolicy` | Image pull policy | `Always` |
| `director.resources` | Resources to initialize the container | `{}` |
| `director.environmentVariables.allowedKeys` | Define the list of comma delimited record keys (provided to the Cypress Runner using `--key` option). Empty or not provided variable means that all record keys are allowed. | `""` |
| `dashboard.environmentVariables.dashboardUrl` | The "Run URL" in the Cypress client | `""` |
| `director.environmentVariables.executionDriver` | Set the execution driver. Valid options are `"../execution/in-memory"` and `"../execution/mongo/driver"` | `"../execution/in-memory"` |
| `director.environmentVariables.mongodbDatabase` | Set the MongoDB database, if the execution driver is set to `"../execution/mongo/driver"` | `sorry-cypress` |
| `director.environmentVariables.screenshotsDriver` | Set the screenshots driver. Valid options are `"../screenshots/dummy.driver"` and `"../screenshots/s3.driver"` | `"../screenshots/dummy.driver"` |
| `director.s3.bucketName` | Set the screenshots storage bucket name, if the screenshots driver is set to `"../screenshots/s3.driver"` | `example-bucket` |
| `director.s3.region` | Set the screenshots storage bucket region, if the screenshots driver is set to `"../screenshots/s3.driver"` | `us-east-1` |
| `director.s3.accessKey` | The `AWS_ACCESS_KEY_ID` environment variable to configure AWS credentials, if the screenshots driver is set to `"../screenshots/s3.driver"` | `abc` |
| `director.s3.secretAccessKey` | The `AWS_SECRET_ACCESS_KEY` environment variable to configure AWS credentials, if the screenshots driver is set to `"../screenshots/s3.driver"` | `zyx` |
| `director.service.port` | Kubernetes service port | `4000` |
| `director.ingress.enabled` | Flag to define if the director service ingress is enabled | `true` |
| `director.ingress.annotations` | Ingress annotations | `{}` |
| `director.ingress.hosts[0].host` | Hostname to the service installation | `director.chart-example.local` |
| `director.ingress.tls` | Ingress secrets for TLS certificates | `[]` |

### Mongo service

If the execution driver is set to `"../execution/mongo/driver"`, you may enable to MongoDB service deploy or provide an external one. Ignore this configuration when using other execution drivers.

| Parameter | Description | Default |
| ------------------------------ | ---------------------------------------------------------------------------------- | --------------- |
| `mongo.enabled` | If enabled, it will deploy the internal MongoDB service. | `false` |
| `mongo.mongoServer` | The mongo server when providing an external one. Use it with `mongo.enabled=false` | `""` |
| `mongo.image.repository` | Image repository | `mongo` |
| `mongo.image.tag` | Image tag | `"4.0"` |
| `mongo.image.pullPolicy` | Image pull policy | `Always` |
| `mongo.persistence.enabled` | Flag for enabling persistent storage | `false` |
| `mongo.persistence.accessMode` | Volumes access mode to be set | `ReadWriteOnce` |
| `mongo.persistence.size` | Size of the volume | `1Gi` |
| `mongo.resources` | Resources to initialize the container | `{}` |
| `mongo.service.port` | Kubernetes service port | `4000` |

0 comments on commit daa0dec

Please sign in to comment.