Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alexellis authored Sep 5, 2022
1 parent de20283 commit 19c8c9b
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ run-job 🏃‍♂️ does the following with a simple YAML file definition:

It's primary usecase is for [checking OpenFaaS installations for customers](/~https://github.com/openfaas/config-checker) where it requires a service account to access various resources in a controlled way.

## Example
## Example 1 - a customer diagnostics tool with a service account

Create a `job.yaml` file:

Expand All @@ -35,6 +35,30 @@ run-job \
-out report.txt
```

## Example 2 - light relief with ASCII cows

cows.yaml:

```yaml
image: alexellis2/cows:latest
name: cows
```
Run the job:
```bash
run-job -f cows.yaml

() ()
()()
(oo)
/-------UU
/ | ||
* ||w---||
^^ ^^
Eh, What's up Doc?
```

## Why does this tool exist?

Running a Job in Kubernetes is confusing:
Expand Down

0 comments on commit 19c8c9b

Please sign in to comment.