Skip to content

docs: Minor adjustments to tutorial #540

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

Merged
merged 1 commit into from
Aug 2, 2023
Merged

docs: Minor adjustments to tutorial #540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 2 additions & 3 deletions doc/usage/aw-02.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@ spec:
schedulingSpec:
minAvailable: 2
resources:
Items:
GenericItems:
- replicas: 1
type: Deployment
template:
generictemplate:
apiVersion: apps/v1
kind: Deployment
metadata:
Expand Down
19 changes: 9 additions & 10 deletions doc/usage/tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,40 +58,40 @@ spec:
memory: 256Mi
```

The yaml file above is used to create an `AppWrapper` named `0001-aw-generic-deployment-2` which encompasses a Kubernetes Job resulting in the creation of 2 pods. The appwrappers's pod will be scheduled by kubernetes scheduler.
The yaml file above is used to create an `AppWrapper` named `0001-aw-generic-deployment-1` which encompasses a Kubernetes Job resulting in the creation of 2 pods. The appwrappers's pod will be scheduled by kubernetes scheduler.

Create the `AppWrapper`

```bash
kubectl create -f aw-01.yaml
```

Check `AppWrapper` job creation with the command below. You should see the `0001-aw-generic-deployment-2` app wrapper.
Check `AppWrapper` job creation with the command below. You should see the `0001-aw-generic-deployment-1` app wrapper.

```bash
$ kubectl get appwrappers
NAME AGE
0001-aw-generic-deployment-2 59s
0001-aw-generic-deployment-1 59s
```

Check `AppWrapper` job status by describing the `AppWrapper`. The `Status:` stanza will show the `State` of `Running` if it has successfully deployed.

```bash
$ kubectl describe appwrapper 0001-aw-generic-deployment-2
$ kubectl describe appwrapper 0001-aw-generic-deployment-1
...
Status:
Canrun: true
...
State: Running
```

Check the pods status of the `AppWrapper` job. There should be 1 `0001-aw-generic-deployment-2` pod running.
Check the pods status of the `AppWrapper` job. There should be 2 `0001-aw-generic-deployment-1` pods running.

```bash
$ kubectl get pods
NAME READY STATUS RESTARTS AGE
0001-aw-generic-deployment-2-79988f7ddd-bmzwb 1/1 Running 0 91s
0001-aw-generic-deployment-2-79988f7ddd-xkrxs 1/1 Running 0 91s
0001-aw-generic-deployment-1-79988f7ddd-bmzwb 1/1 Running 0 91s
0001-aw-generic-deployment-1-79988f7ddd-xkrxs 1/1 Running 0 91s
```

This step showed a simple deployment of an `AppWrapper` job. The next step will show how queuing works in the __Multi-Cluster Application Dispatcher__ Controller.
Expand Down Expand Up @@ -210,10 +210,9 @@ spec:
schedulingSpec:
minAvailable: 2
resources:
Items:
GenericItems:
- replicas: 1
type: Deployment
template:
generictemplate:
apiVersion: apps/v1
kind: Deployment
metadata:
Expand Down