Skip to content

Commit 030f382

Browse files
committed
update website to include better quickstart
1 parent 9e9619b commit 030f382

35 files changed

+18
-2021
lines changed

_data/settings.yml

+11-15
Original file line numberDiff line numberDiff line change
@@ -25,26 +25,22 @@ blog_settings:
2525
# Should we display a narrow grid of other posts at the bottom of each blog post?
2626
read_more: "yes"
2727

28-
# Setup your navigation below – how to use the icons:
28+
# Setup your navigation below – how to use the icons:
2929
# 1. See all the icons available here https://demos.creative-tim.com/argon-design-system-pro/docs/1.0/foundation/icons.html
30-
# 2. Get the name of the icon e.g basket, then prefix with ni to make ni-basket.
31-
# 3. Add a color of the icon - text-primary, text-success, text-info, text-danger, text-warning and text-default all work!
30+
# 2. Get the name of the icon e.g basket, then prefix with ni to make ni-basket.
31+
# 3. Add a color of the icon - text-primary, text-success, text-info, text-danger, text-warning and text-default all work!
3232
menu_settings:
3333
menu_items:
3434
- title: 'Design'
3535
url: '/design/'
3636
- title: 'Documentation'
3737
submenu_items:
38-
- title: 'Development'
39-
url: '/developer'
38+
- title: 'Quickstart'
39+
url: '/quickstart'
4040
- title: 'User Guide'
41-
url: '/user'
42-
- title: 'Production Install'
43-
url: '/production-install'
41+
url: '/user'
4442
- title: 'Libraries'
4543
url: '/libraries'
46-
- title: 'Demo'
47-
url: '/demo'
4844
- title: 'Contribute'
4945
url: '/contribute'
5046

@@ -59,7 +55,7 @@ contact_settings:
5955

6056
social_settings:
6157
facebook_url: ''
62-
discussions_url: 'https://github.com/G-Research/armada/discussions'
58+
discussions_url: 'https://github.com/armadaproject/armada/discussions'
6359
twitter_url: 'https://twitter.com/oss_gr'
6460
instagram_url: ''
6561
youtube_url: ''
@@ -68,14 +64,14 @@ social_settings:
6864
gitter_url: ''
6965
dribbble_url: ''
7066
behance_url: ''
71-
github_url: 'https://github.com/G-Research/armada'
67+
github_url: 'https://github.com/armadaproject/armada'
7268
reddit_url: ''
7369
linkedin_url: ''
7470
slack_url: 'https://cloud-native.slack.com/archives/C03T9CBCEMC'
7571

7672
authors:
7773

7874
advanced_settings:
79-
analytics_code: 'G-SKPDW30VNF'
80-
header_js:
81-
footer_js:
75+
analytics_code: 'G-SKPDW30VNF'
76+
header_js:
77+
footer_js:

quickstart.md

+4-130
Original file line numberDiff line numberDiff line change
@@ -1,133 +1,7 @@
1-
# Armada Quickstart
1+
# Quickstart
22

3-
The purpose of this guide is to install a minimal local Armada deployment for testing and evaluation purposes.
3+
Easiest way to install **Armada** is by using the **Armada Operator**, a Kubernetes operator that manages the lifecycle of **Armada components**.
44

5-
## Pre-requisites
5+
The operator is available in the [Armada Operator repository](https://github.com/armadaproject/armada-operator).
66

7-
- Git
8-
- Docker (Docker Desktop recommended for local development on Windows/OSX)
9-
- Helm v3.5+
10-
- Kind v0.11.1+
11-
- Kubectl
12-
13-
## Installation
14-
This guide will install Armada on 3 local Kubernetes clusters; one server and two executor clusters.
15-
16-
You should then clone this repository and step into it:
17-
18-
```bash
19-
git clone https://github.com/G-Research/armada.git
20-
cd armada
21-
```
22-
23-
All commands are intended to be run from the root of the repository.
24-
25-
Armada is a resource intensive application due to the need to run multiple Kubernetes clusters - for a local installation you will need at least 16GB of RAM available.
26-
27-
### One-click Setup
28-
29-
To install Armada and all its dependencies you can use this script:
30-
https://github.com/G-Research/armada/blob/master/docs/local/setup.sh
31-
32-
Likewise this script will remove the Armada components from your system:
33-
https://github.com/G-Research/armada/blob/master/docs/local/destroy.sh
34-
35-
36-
## Usage
37-
Create queues, submit some jobs and monitor progress:
38-
39-
### Queue Creation
40-
```bash
41-
./armadactl create queue queue-a --priorityFactor 1
42-
./armadactl create queue queue-b --priorityFactor 2
43-
```
44-
For queues created in this way, user and group owners of the queue have permissions to:
45-
- submit jobs
46-
- cancel jobs
47-
- reprioritize jobs
48-
- watch queue
49-
50-
For more control, queues can be created via `armadactl create`, which allows for setting specific permission; see the following example.
51-
52-
```bash
53-
./armadactl create -f ./docs/quickstart/queue-a.yaml
54-
./armadactl create -f ./docs/quickstart/queue-b.yaml
55-
```
56-
57-
58-
### Job Submission
59-
```
60-
./armadactl submit ./docs/quickstart/job-queue-a.yaml
61-
./armadactl submit ./docs/quickstart/job-queue-b.yaml
62-
```
63-
64-
Watch individual queues:
65-
66-
```bash
67-
./armadactl watch queue-a job-set-1
68-
```
69-
```bash
70-
./armadactl watch queue-b job-set-1
71-
```
72-
73-
Log in to the Grafana dashboard at [http://localhost:30001](http://localhost:30001) using the default credentials of `admin` / `prom-operator`.
74-
Navigate to the Armada Overview dashboard to get a view of jobs progressing through the system.
75-
76-
Try submitting lots of jobs and see queues get built and processed:
77-
78-
```bash
79-
for i in {1..50}
80-
do
81-
./armadactl submit ./docs/quickstart/job-queue-a.yaml
82-
./armadactl submit ./docs/quickstart/job-queue-b.yaml
83-
done
84-
```
85-
86-
## Example output:
87-
88-
CLI:
89-
90-
```bash
91-
$ ./armadactl watch queue-a job-set-1
92-
Watching job set job-set-1
93-
Nov 4 11:43:36 | Queued: 0, Leased: 0, Pending: 0, Running: 0, Succeeded: 0, Failed: 0, Cancelled: 0 | event: *api.JobSubmittedEvent, job id: 01drv3mey2mzmayf50631tzp9m
94-
Nov 4 11:43:36 | Queued: 1, Leased: 0, Pending: 0, Running: 0, Succeeded: 0, Failed: 0, Cancelled: 0 | event: *api.JobQueuedEvent, job id: 01drv3mey2mzmayf50631tzp9m
95-
Nov 4 11:43:36 | Queued: 1, Leased: 0, Pending: 0, Running: 0, Succeeded: 0, Failed: 0, Cancelled: 0 | event: *api.JobSubmittedEvent, job id: 01drv3mf7b6fd1rraeq1f554fn
96-
Nov 4 11:43:36 | Queued: 2, Leased: 0, Pending: 0, Running: 0, Succeeded: 0, Failed: 0, Cancelled: 0 | event: *api.JobQueuedEvent, job id: 01drv3mf7b6fd1rraeq1f554fn
97-
Nov 4 11:43:38 | Queued: 1, Leased: 1, Pending: 0, Running: 0, Succeeded: 0, Failed: 0, Cancelled: 0 | event: *api.JobLeasedEvent, job id: 01drv3mey2mzmayf50631tzp9m
98-
Nov 4 11:43:38 | Queued: 0, Leased: 2, Pending: 0, Running: 0, Succeeded: 0, Failed: 0, Cancelled: 0 | event: *api.JobLeasedEvent, job id: 01drv3mf7b6fd1rraeq1f554fn
99-
Nov 4 11:43:38 | Queued: 0, Leased: 1, Pending: 1, Running: 0, Succeeded: 0, Failed: 0, Cancelled: 0 | event: *api.JobPendingEvent, job id: 01drv3mey2mzmayf50631tzp9m
100-
Nov 4 11:43:38 | Queued: 0, Leased: 0, Pending: 2, Running: 0, Succeeded: 0, Failed: 0, Cancelled: 0 | event: *api.JobPendingEvent, job id: 01drv3mf7b6fd1rraeq1f554fn
101-
Nov 4 11:43:41 | Queued: 0, Leased: 0, Pending: 1, Running: 1, Succeeded: 0, Failed: 0, Cancelled: 0 | event: *api.JobRunningEvent, job id: 01drv3mf7b6fd1rraeq1f554fn
102-
Nov 4 11:43:41 | Queued: 0, Leased: 0, Pending: 0, Running: 2, Succeeded: 0, Failed: 0, Cancelled: 0 | event: *api.JobRunningEvent, job id: 01drv3mey2mzmayf50631tzp9m
103-
Nov 4 11:44:17 | Queued: 0, Leased: 0, Pending: 0, Running: 1, Succeeded: 1, Failed: 0, Cancelled: 0 | event: *api.JobSucceededEvent, job id: 01drv3mf7b6fd1rraeq1f554fn
104-
Nov 4 11:44:26 | Queued: 0, Leased: 0, Pending: 0, Running: 0, Succeeded: 2, Failed: 0, Cancelled: 0 | event: *api.JobSucceededEvent, job id: 01drv3mey2mzmayf50631tzp9m
105-
```
106-
107-
108-
### Grafana Configuration
109-
110-
Run the following commands to setup Grafana in your environment:
111-
112-
```bash
113-
curl -X POST -i http://admin:prom-operator@localhost:30001/api/datasources -H "Content-Type: application/json" -d '{"name":"cluster-0","type":"prometheus","url":"http://'$EXECUTOR_0_IP':30001","access":"proxy","basicAuth":false}'
114-
curl -X POST -i http://admin:prom-operator@localhost:30001/api/datasources -H "Content-Type: application/json" -d '{"name":"cluster-1","type":"prometheus","url":"http://'$EXECUTOR_1_IP':30001","access":"proxy","basicAuth":false}'
115-
curl -X POST -i http://admin:prom-operator@localhost:30001/api/dashboards/import --data-binary @./docs/quickstart/grafana-armada-dashboard.json -H "Content-Type: application/json"
116-
```
117-
118-
Grafana:
119-
120-
![Armada Grafana dashboard](./quickstart/grafana-screenshot.png "Armada Grafana dashboard")
121-
122-
Note that the jobs in this demo simply run the `sleep` command so do not consume many resources.
123-
124-
### Lookout Configuration
125-
126-
Armada Lookout UI can be configured by doing the following:
127-
128-
```bash
129-
kubectl port-forward svc/armada-lookout 8080:8080
130-
```
131-
Then access it by opening [http://localhost:8080](http://localhost:8080) in your browser.
132-
133-
![Lookout UI](./quickstart/lookout.png "Lookout UI")
7+
Follow the [Quickstart](https://github.com/armadaproject/armada-operator?tab=readme-ov-file#quickstart) to create your first Armada cluster.

quickstart/executor-cluster-monitoring-values.yaml

-5
This file was deleted.

quickstart/executor-prometheus-values.yaml

-22
This file was deleted.

quickstart/executor-values.yaml

-11
This file was deleted.

0 commit comments

Comments
 (0)