Skip to content

Commit d038aaf

Browse files
committed
docs: Fix typos, inconsistencies in docs
Signed-off-by: Anastassios Nanos <ananos@nubificus.co.uk>
1 parent a056db8 commit d038aaf

File tree

3 files changed

+29
-27
lines changed

3 files changed

+29
-27
lines changed

docs/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs.mlsysops.eu

docs/quickstart.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ There are two services that provide additional functionalities to the user:
2323
- **ML Connector**: This service is responsible for managing and deploying Machine Learning models. It exposes its functionality through a separate API.
2424

2525
To ensure the correct bootstrap, the agents should start in the following order:
26+
2627
1. Continuum agent
2728
2. Cluster agent
2829
3. Node agents
@@ -76,7 +77,7 @@ Descriptions define IDs, managed components, and resource details. All files are
7677

7778
There are two ways to deploy the framework:
7879

79-
#### Option 1: Automated using the MLSysOps CLI
80+
#### Option 1: Automated using the MLSysOps CLI
8081

8182
You can install the CLI in two ways:
8283

@@ -112,6 +113,7 @@ mls framework deploy-all
112113
```
113114

114115
This will:
116+
115117
- Deploy core services (ejabberd, redis, API service)
116118
- Register system descriptions
117119
- Deploy all agents in correct order
@@ -130,13 +132,11 @@ Wait for all pods to be created:
130132
kubectl get pods -n mlsysops-framework
131133
```
132134

133-
---
134-
135-
#### 🛠 Option 2: Manual Deployment
135+
#### Option 2: Manual Deployment
136136

137137
Follow the order below to deploy manually if you prefer full control.
138138

139-
### 📍 Management Cluster (Continuum)
139+
### Management Cluster (Continuum)
140140

141141
```bash
142142
export KUBECONFIG=<host kubeconfig>
@@ -175,7 +175,7 @@ kubectl create configmap continuum-system-description --from-file=descriptions/c
175175
kubectl apply -f continuum-agent-daemonset.yaml
176176
```
177177

178-
### 📍 Karmada API Cluster (Cluster Agents)
178+
### Karmada API Cluster (Cluster Agents)
179179

180180
```bash
181181
export KUBECONFIG=<api kubeconfig>
@@ -199,29 +199,30 @@ kubectl create configmap cluster-system-description --from-file=descriptions/clu
199199
kubectl apply -f cluster-agents-daemonset.yaml
200200
```
201201

202-
### 📍 Node Agents
202+
### Node Agents
203203

204204
- Ensure node descriptions are in place
205205
- Add them via ConfigMap:
206+
206207
```bash
207208
kubectl create configmap node-system-descriptions --from-file=descriptions/nodes --namespace=mlsysops-framework
208209
```
209210

210211
- Start Node Agents:
212+
211213
```bash
212214
kubectl apply -f node-agents-daemonset.yaml
213215
```
214216

215-
---
216-
217217
#### Step 4: Deploy a test application
218218

219219
We use a simple TCP Client - Server application, that send messages periodically.
220220
The files are in `tests/application` of the repo.
221221

222-
Update the test_CR and test_MLSysOps_description, with the node names of the cluster and the clusterID.
222+
Update the `test_CR` and `test_MLSysOps_description`, with the node names of the cluster and the clusterID.
223223

224224
apply the CR:
225+
225226
`kubectl apply -f tests/application/test_CR.yaml`
226227

227228
or the description via the MLS CLI:

docs/testbed.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ To install the MLSysOps framework, you will need one or more kubernetes clusters
66

77
[Prerequisites](#prerequisites)
88
[Installation Steps](#installation-steps)
9-
* [Setting Up Ansible](#setting-up-ansible)
10-
* [Inventory Configuration](#inventory-configuration)
11-
* [k3s Installation Playbook](#k3s-installation-playbook)
12-
* [Karmada Installation Playbook](#karmada-installation-playbook)
9+
[Setting Up Ansible](#setting-up-ansible)
10+
[Inventory Configuration](#inventory-configuration)
11+
[k3s Installation Playbook](#k3s-installation-playbook)
12+
[Karmada Installation Playbook](#karmada-installation-playbook)
1313

1414
## Prerequisites
1515
Before proceeding, ensure the following:
@@ -27,26 +27,26 @@ To set up Ansible, run the follow commands on the control node:
2727

2828
1) Update System Packages to latest version.
2929

30-
```
31-
sudo apt update && sudo apt upgrade -y
32-
```
30+
```
31+
sudo apt update && sudo apt upgrade -y
32+
```
3333
2) Install essential packages that Ansible relies on:
3434

35-
```
36-
sudo apt install -y python3 software-properties-common
37-
```
35+
```
36+
sudo apt install -y python3 software-properties-common
37+
```
3838
3) Install Ansible.
3939

40-
```
41-
sudo apt install -y ansible
42-
```
40+
```
41+
sudo apt install -y ansible
42+
```
4343
4) After installation, confirm that Ansible is installed and working correctly by checking its version:
44-
```
45-
ansible --version
46-
```
44+
```
45+
ansible --version
46+
```
4747
Example output:
4848

49-
```
49+
```console
5050
ansible 2.10.8
5151
config file = None
5252
configured module search path = ['/home/pmavrikos/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']

0 commit comments

Comments
 (0)