From e837144eee935191c6ddf4811a5938ad91d3367b Mon Sep 17 00:00:00 2001 From: Dave Dozier <2555178+dwdozier@users.noreply.github.com> Date: Fri, 27 Oct 2023 22:03:41 -0400 Subject: [PATCH] Update README - 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 --- .gitignore | 4 ++-- README.md | 31 +++++++++++++++++++------------ 2 files changed, 21 insertions(+), 14 deletions(-) diff --git a/.gitignore b/.gitignore index 9ae14b3..4ea5a94 100644 --- a/.gitignore +++ b/.gitignore @@ -12,6 +12,6 @@ old-index.yaml # rspec failure tracking .rspec_status client -.vscode/settings.json .env -.vscode/launch.json +.vscode/ +.idea/ \ No newline at end of file diff --git a/README.md b/README.md index 7da7239..176f576 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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| @@ -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: