Skip to content

Commit

Permalink
Update README (#17)
Browse files Browse the repository at this point in the history
- update readme to include commands to update to the latest Kubetruth
  - update gitignore
    - add .idea for IntelliJ IDEs
    - modify .vscode entries to ignore the entire directory
  • Loading branch information
dwdozier authored Nov 7, 2023
1 parent e8a3fc8 commit 6e0e9fb
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 14 deletions.
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ old-index.yaml
# rspec failure tracking
.rspec_status
client
.vscode/settings.json
.env
.vscode/launch.json
.vscode/
.idea/
31 changes: 19 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@ names of the resources created at install time. Thus in the examples below, a
name like `kubetruth-root` for the default installed CRD would be different in
your system if you gave `helm install` a different release name.

## Update

```shell
helm repo update
helm upgrade kubetruth cloudtruth/kubetruth
```

## Uninstall

```shell
Expand Down Expand Up @@ -181,17 +188,17 @@ ones:

| Custom Filters | Description |
|-----------------|-------------|
| `dns_safe` | Ensures the string is safe for use as a kubernetes resource name (i.e. Namespace/ConfigMap/Secret names) |
| `env_safe` | Ensures the string is safe for setting as a shell environment variable |
| `key_safe` | Ensures the string is safe for use as a key inside a ConfigMap/Secret data hash |
| `indent: count` | Indents each line in the argument by count spaces |
| `nindent: count` | Adds a leading newline, then indents each line in the argument by count spaces |
| `stringify` | Converts argument to a string safe to use in yaml (escapes quotes and surrounds with the quote character) |
| `parse_yaml` | Parses yaml string into a structured representation |
| `to_yaml` | Converts object to a yaml representation |
| `parse_json` | Parses json string into a structured representation |
| `to_json` | Converts object to a json representation |
| `encode64` | The argument bas64 encoded |
| `dns_safe` | Ensures the string is safe for use as a kubernetes resource name (i.e. Namespace/ConfigMap/Secret names) |
| `env_safe` | Ensures the string is safe for setting as a shell environment variable |
| `key_safe` | Ensures the string is safe for use as a key inside a ConfigMap/Secret data hash |
| `indent: count` | Indents each line in the argument by count spaces |
| `nindent: count` | Adds a leading newline, then indents each line in the argument by count spaces |
| `stringify` | Converts argument to a string safe to use in yaml (escapes quotes and surrounds with the quote character) |
| `parse_yaml` | Parses yaml string into a structured representation |
| `to_yaml` | Converts object to a yaml representation |
| `parse_json` | Parses json string into a structured representation |
| `to_json` | Converts object to a json representation |
| `encode64` | The argument bas64 encoded |
| `decode64` | The argument bas64 decoded |
| `sha256` | The sha256 digest of the argument |
| `inflate` | Converts a map of key/values into a nested data structure based on a delimiter in the key name, e.g. `{foo.baz.bum: 2}` => `{foo: {bar: {baz: 2}}}` Inverse of deflate|
Expand Down Expand Up @@ -381,7 +388,7 @@ After checking out the repo, run `bundle` to install dependencies. Then, run
interactive prompt that will allow you to experiment.
To install and run via helm in a local cluster:
```
```
mkdir local
cat > local/values.yml <<-EOF
image:
Expand Down

0 comments on commit 6e0e9fb

Please sign in to comment.