Skip to content

Commit

Permalink
Readme: prefetch-deps: example of usage of configfile
Browse files Browse the repository at this point in the history
Add example how config file should be used

Signed-off-by: Martin Basti <[email protected]>
  • Loading branch information
MartinBasti committed Jul 25, 2024
1 parent 5004c6a commit 6d5f154
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
15 changes: 15 additions & 0 deletions task/prefetch-dependencies-oci-ta/0.1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,21 @@ https://github.com/containerbuildsystem/cachi2#basic-usage.
|ociArtifactExpiresAfter|Expiration date for the trusted artifacts created in the OCI repository. An empty string means the artifacts do not expire.|""|false|
|ociStorage|The OCI repository where the Trusted Artifacts are stored.||true|

### Config file usage

Config file must be passed as a YAML string. For all available config options please check [available configuration parameters]("https://github.com/containerbuildsystem/cachi2?tab=readme-ov-file#available-configuration-parameters") page.

Example of setting timeouts:

```yaml
params:
- name: config-file-content
value: |
---
requests_timeout: 300
subprocess_timeout:3600
```
## Results
|name|description|
|---|---|
Expand Down
15 changes: 15 additions & 0 deletions task/prefetch-dependencies/0.1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,21 @@ See docs at https://github.com/containerbuildsystem/cachi2#basic-usage.
|caTrustConfigMapName|The name of the ConfigMap to read CA bundle data from.|trusted-ca|false|
|caTrustConfigMapKey|The name of the key in the ConfigMap that contains the CA bundle data.|ca-bundle.crt|false|

### Config file usage

Config file must be passed as a YAML string. For all available config options please check [available configuration parameters]("https://github.com/containerbuildsystem/cachi2?tab=readme-ov-file#available-configuration-parameters") page.

Example of setting timeouts:

```yaml
params:
- name: config-file-content
value: |
---
requests_timeout: 300
subprocess_timeout:3600
```
## Workspaces
|name|description|optional|
|---|---|---|
Expand Down

0 comments on commit 6d5f154

Please sign in to comment.