Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Update memoization.md #10992

Merged
merged 3 commits into from
May 10, 2023
Merged

docs: Update memoization.md #10992

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6fadaca
Update memoization.md
Apr 27, 2023
9539f16
Updated spelling after running `make docs`.
Apr 28, 2023
b6a1917
Merge branch 'master' into patch-2
terrytangyuan May 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/memoization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@ This allows you to easily manipulate cache entries manually through `kubectl` an

## Using Memoization

Memoization is set at the template level. You must specify a key, which can be static strings but more often depend on inputs.
You must also specify a name for the config-map cache.
Memoization is set at the template level. You must specify a `key`, which can be static strings but more often depend on inputs.
You must also specify a name for the `config-map` cache.
Optionally you can set a `maxAge` in seconds or hours (e.g. `180s`, `24h`) to define how long should it be considered valid. If an entry is older than the `maxAge`, it will be ignored.

```yaml
apiVersion: argoproj.io/v1alpha1
Expand All @@ -29,11 +30,14 @@ spec:
- name: whalesay
memoize:
key: "{{inputs.parameters.message}}"
maxAge: "10s"
cache:
configMap:
name: whalesay-cache
```

[Find a simple example for memoization here](https://github.com/argoproj/argo-workflows/blob/master/examples/memoize-simple.yaml).

!!! Note
In order to use memoization it is necessary to add the verbs `create` and `update` to the `configmaps` resource for the appropriate (cluster) roles. In the case of a cluster install the `argo-cluster-role` cluster role should be updated, whilst for a namespace install the `argo-role` role should be updated.

Expand Down