Skip to content

Commit

Permalink
[chore] - update README.md (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
ahrav authored Sep 20, 2023
1 parent 8a26c93 commit 6ee6f58
Showing 1 changed file with 44 additions and 7 deletions.
51 changes: 44 additions & 7 deletions trufflehog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,49 @@ The `values.yaml` file provides configuration options for the Trufflehog Helm ch

To adjust these configurations:

1. Modify the `values.yaml` file directly, or
2. Provide overrides during the Helm install command.
## Configuration

Example:
```bash
helm install trufflehog trufflesecurity/trufflehog --namespace trufflehog --set replicaCount=2
```
### 1. Before Installing:

Modify the `values.yaml` file directly in the chart directory to adjust the default values.

### 2. During Installation:

- **Using `--set` Flag**:

```bash
helm install trufflehog trufflesecurity/trufflehog --namespace trufflehog --set replicaCount=2
```

This command overrides the `replicaCount` value, setting it to 2 instead of the default.

- **Using a Custom `values.yaml`**:

Modify your local copy of `values.yaml`. Then:

```bash
helm install trufflehog trufflesecurity/trufflehog --namespace trufflehog -f /path/to/your/values.yaml
```

### 3. After Installation:

If you've already installed the Helm release and want to modify the values:
- **Using `--set` Flag**:
```bash
helm upgrade trufflehog trufflesecurity/trufflehog --namespace trufflehog --set replicaCount=3
```
This command upgrades the existing release with the new value.
- **Using a Custom `values.yaml`**:
Modify your local copy of `values.yaml` as needed. Then:
```bash
helm upgrade trufflehog trufflesecurity/trufflehog --namespace trufflehog -f /path/to/your/values.yaml
```
This command upgrades the existing release using the modified `values.yaml` file.
This command overrides the `replicaCount` value, setting it to 2 instead of the default.

0 comments on commit 6ee6f58

Please sign in to comment.