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.

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

fix(docs): replace outdated whalesay image with busybox #13429

Merged
merged 3 commits into from
Aug 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 14 additions & 14 deletions docs/cluster-workflow-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,16 @@ can be created cluster scoped like `ClusterRole` and can be accessed across all
apiVersion: argoproj.io/v1alpha1
kind: ClusterWorkflowTemplate
metadata:
name: cluster-workflow-template-whalesay-template
name: cluster-workflow-template-print-message
spec:
templates:
- name: whalesay-template
- name: print-message
inputs:
parameters:
- name: message
container:
image: docker/whalesay
command: [cowsay]
image: busybox
command: [echo]
args: ["{{inputs.parameters.message}}"]
```

Expand All @@ -41,14 +41,14 @@ kind: Workflow
metadata:
generateName: workflow-template-hello-world-
spec:
entrypoint: whalesay
entrypoint: hello-world
templates:
- name: whalesay
- name: hello-world
steps: # You should only reference external "templates" in a "steps" or "dag" "template".
- - name: call-whalesay-template
- - name: call-print-message
templateRef: # You can reference a "template" from another "WorkflowTemplate or ClusterWorkflowTemplate" using this field
name: cluster-workflow-template-whalesay-template # This is the name of the "WorkflowTemplate or ClusterWorkflowTemplate" CRD that contains the "template" you want
template: whalesay-template # This is the name of the "template" you want to reference
name: cluster-workflow-template-print-message # This is the name of the "WorkflowTemplate or ClusterWorkflowTemplate" CRD that contains the "template" you want
template: print-message # This is the name of the "template" you want to reference
clusterScope: true # This field indicates this templateRef is pointing ClusterWorkflowTemplate
arguments: # You can pass in arguments as normal
parameters:
Expand All @@ -70,19 +70,19 @@ kind: ClusterWorkflowTemplate
metadata:
name: cluster-workflow-template-submittable
spec:
entrypoint: whalesay-template
entrypoint: print-message
arguments:
parameters:
- name: message
value: hello world
templates:
- name: whalesay-template
- name: print-message
inputs:
parameters:
- name: message
container:
image: docker/whalesay
command: [cowsay]
image: busybox
command: [echo]
args: ["{{inputs.parameters.message}}"]

```
Expand All @@ -95,7 +95,7 @@ kind: Workflow
metadata:
generateName: cluster-workflow-template-hello-world-
spec:
entrypoint: whalesay-template
entrypoint: print-message
arguments:
parameters:
- name: message
Expand Down
16 changes: 8 additions & 8 deletions docs/configure-archive-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ metadata:
generateName: archive-location-
spec:
archiveLogs: true
entrypoint: whalesay
entrypoint: hello-world
templates:
- name: whalesay
- name: hello-world
container:
image: docker/whalesay:latest
command: [cowsay]
image: busybox
command: [echo]
args: ["hello world"]
```

Expand All @@ -51,12 +51,12 @@ kind: Workflow
metadata:
generateName: archive-location-
spec:
entrypoint: whalesay
entrypoint: hello-world
templates:
- name: whalesay
- name: hello-world
container:
image: docker/whalesay:latest
command: [cowsay]
image: busybox
command: [echo]
args: ["hello world"]
archiveLocation:
archiveLogs: true
Expand Down
4 changes: 2 additions & 2 deletions docs/cron-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ spec:
concurrencyPolicy: "Replace"
startingDeadlineSeconds: 0
workflowSpec:
entrypoint: whalesay
entrypoint: date
templates:
- name: whalesay
- name: date
container:
image: alpine:3.6
command: [sh, -c]
Expand Down
8 changes: 4 additions & 4 deletions docs/debug-pause.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ kind: Workflow
metadata:
generateName: pause-after-
spec:
entrypoint: whalesay
entrypoint: argosay
templates:
- name: whalesay
- name: argosay
container:
image: argoproj/argosay:v2
env:
Expand All @@ -43,9 +43,9 @@ kind: Workflow
metadata:
generateName: pause-after-
spec:
entrypoint: whalesay
entrypoint: argosay
templates:
- name: whalesay
- name: argosay
container:
image: argoproj/argosay:v2
env:
Expand Down
6 changes: 3 additions & 3 deletions docs/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The event endpoint will always return in under 10 seconds because the event will
## Workflow Template triggered by the event

Before the binding between an event and a workflow template, you must create the workflow template that you want to trigger.
The following one takes in input the "message" parameter specified into the API call body, passed through the `WorkflowEventBinding` parameters section, and finally resolved here as the message of the `whalesay` image.
The following one takes in input the "message" parameter specified into the API call body, passed through the `WorkflowEventBinding` parameters section, and finally resolved here as the message of the `main` template.

```yaml
apiVersion: argoproj.io/v1alpha1
Expand All @@ -56,8 +56,8 @@ spec:
- name: message
value: "{{workflow.parameters.message}}"
container:
image: docker/whalesay:latest
command: [cowsay]
image: busybox
command: [echo]
args: ["{{inputs.parameters.message}}"]
entrypoint: main
```
Expand Down
6 changes: 3 additions & 3 deletions docs/memoization.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ kind: Workflow
metadata:
generateName: memoized-workflow-
spec:
entrypoint: whalesay
entrypoint: print-message
templates:
- name: whalesay
- name: print-message
memoize:
key: "{{inputs.parameters.message}}"
maxAge: "10s"
cache:
configMap:
name: whalesay-cache
name: print-message-cache
```

[Find a simple example for memoization here](https://github.com/argoproj/argo-workflows/blob/main/examples/memoize-simple.yaml).
Expand Down
8 changes: 4 additions & 4 deletions docs/rest-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,16 @@ curl --request POST \
"spec": {
"templates": [
{
"name": "whalesay",
"name": "hello-world",
"arguments": {},
"inputs": {},
"outputs": {},
"metadata": {},
"container": {
"name": "",
"image": "docker/whalesay:latest",
"image": "busybox",
"command": [
"cowsay"
"echo"
],
"args": [
"hello world"
Expand All @@ -48,7 +48,7 @@ curl --request POST \
}
}
],
"entrypoint": "whalesay",
"entrypoint": "hello-world",
"arguments": {}
}
}
Expand Down
16 changes: 8 additions & 8 deletions docs/synchronization.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,17 +38,17 @@ kind: Workflow
metadata:
generateName: synchronization-wf-level-
spec:
entrypoint: whalesay
entrypoint: hello-world
synchronization:
semaphore:
configMapKeyRef:
name: my-config
key: workflow
templates:
- name: whalesay
- name: hello-world
container:
image: docker/whalesay:latest
command: [cowsay]
image: busybox
command: [echo]
args: ["hello world"]
```

Expand All @@ -60,15 +60,15 @@ kind: Workflow
metadata:
generateName: synchronization-wf-level-
spec:
entrypoint: whalesay
entrypoint: hello-world
synchronization:
mutex:
name: workflow
templates:
- name: whalesay
- name: hello-world
container:
image: docker/whalesay:latest
command: [cowsay]
image: busybox
command: [echo]
args: ["hello world"]
```

Expand Down
2 changes: 1 addition & 1 deletion docs/template-defaults.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ spec:
templates:
- name: main
container:
image: docker/whalesay:latest
image: busybox
```
[template defaults example](https://github.com/argoproj/argo-workflows/main/examples/template-defaults.yaml)
Expand Down
2 changes: 1 addition & 1 deletion docs/tolerating-pod-deletion.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ spec:
templates:
- name: main
container:
image: docker/whalesay:latest
image: busybox
command:
- sleep
- 30s
Expand Down
9 changes: 5 additions & 4 deletions docs/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,16 +55,17 @@ If you are incorrectly configured, the workflow controller will error on start-u

#### Actions

You don't need to configure images that use v2 manifests anymore. You can just remove them (e.g. argoproj/argosay:v2):
You don't need to configure images that use v2 manifests anymore, such as `argoproj/argosay:v2`.
You can remove them:

```bash
% docker manifest inspect argoproj/argosay:v2
...
# ...
"schemaVersion": 2,
...
# ...
```

For v1 manifests (e.g. docker/whalesay:latest):
For v1 manifests, such as `docker/whalesay:latest`:

```bash
% docker image inspect -f '{{.Config.Entrypoint}} {{.Config.Cmd}}' docker/whalesay:latest
Expand Down
8 changes: 4 additions & 4 deletions docs/variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ kind: Workflow
metadata:
generateName: hello-world-parameters-
spec:
entrypoint: whalesay
entrypoint: print-message
arguments:
parameters:
- name: message
value: hello world
templates:
- name: whalesay
- name: print-message
inputs:
parameters:
- name: message
container:
image: docker/whalesay
command: [ cowsay ]
image: busybox
command: [ echo ]
args: [ "{{inputs.parameters.message}}" ]
```

Expand Down
18 changes: 9 additions & 9 deletions docs/walk-through/artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

When running workflows, it is very common to have steps that generate or consume artifacts. Often, the output artifacts of one step may be used as input artifacts to a subsequent step.

The below workflow spec consists of two steps that run in sequence. The first step named `generate-artifact` will generate an artifact using the `whalesay` template that will be consumed by the second step named `print-message` that then consumes the generated artifact.
The below workflow spec consists of two steps that run in sequence. The first step named `generate-artifact` will generate an artifact using the `hello-world-to-file` template that will be consumed by the second step named `print-message-from-file` that then consumes the generated artifact.

```yaml
apiVersion: argoproj.io/v1alpha1
Expand All @@ -18,29 +18,29 @@ spec:
- name: artifact-example
steps:
- - name: generate-artifact
template: whalesay
template: hello-world-to-file
- - name: consume-artifact
template: print-message
template: print-message-from-file
arguments:
artifacts:
# bind message to the hello-art artifact
# generated by the generate-artifact step
- name: message
from: "{{steps.generate-artifact.outputs.artifacts.hello-art}}"

- name: whalesay
- name: hello-world-to-file
container:
image: docker/whalesay:latest
image: busybox
command: [sh, -c]
args: ["cowsay hello world | tee /tmp/hello_world.txt"]
args: ["echo hello world | tee /tmp/hello_world.txt"]
outputs:
artifacts:
# generate hello-art artifact from /tmp/hello_world.txt
# artifacts can be directories as well as files
- name: hello-art
path: /tmp/hello_world.txt

- name: print-message
- name: print-message-from-file
inputs:
artifacts:
# unpack the message input artifact
Expand All @@ -53,8 +53,8 @@ spec:
args: ["cat /tmp/message"]
```

The `whalesay` template uses the `cowsay` command to generate a file named `/tmp/hello-world.txt`. It then `outputs` this file as an artifact named `hello-art`. In general, the artifact's `path` may be a directory rather than just a file. The `print-message` template takes an input artifact named `message`, unpacks it at the `path` named `/tmp/message` and then prints the contents of `/tmp/message` using the `cat` command.
The `artifact-example` template passes the `hello-art` artifact generated as an output of the `generate-artifact` step as the `message` input artifact to the `print-message` step. DAG templates use the tasks prefix to refer to another task, for example `{{tasks.generate-artifact.outputs.artifacts.hello-art}}`.
The `hello-world-to-file` template uses the `echo` command to generate a file named `/tmp/hello-world.txt`. It then `outputs` this file as an artifact named `hello-art`. In general, the artifact's `path` may be a directory rather than just a file. The `print-message-from-file` template takes an input artifact named `message`, unpacks it at the `path` named `/tmp/message` and then prints the contents of `/tmp/message` using the `cat` command.
The `artifact-example` template passes the `hello-art` artifact generated as an output of the `generate-artifact` step as the `message` input artifact to the `print-message-from-file` step. DAG templates use the tasks prefix to refer to another task, for example `{{tasks.generate-artifact.outputs.artifacts.hello-art}}`.

Optionally, for large artifacts, you can set `podSpecPatch` in the workflow spec to increase the resource request for the init container and avoid any Out of memory issues.

Expand Down
Loading
Loading