Commit 1880dedc authored by Sergio Gimenez's avatar Sergio Gimenez
Browse files

Fix docs

parent d7404060

docs/deployment-guides/single-oop.md

+15 −19
Original line number Diff line number Diff line
@@ -16,6 +16,7 @@ The Single OOP deployment is the most common and straightforward scenario. It cr 
- Unified dashboard for easy access (Homer)



This deployment is perfect for:



- **Development** and testing

- **Demos** and proof-of-concepts

- **Learning** the platform
@@ -37,13 +38,16 @@ If you've already set everything up, deploy with: 
```bash

cd ansible

source venv/bin/activate

ansible-playbook playbooks/scenarios/deploy_quick_single_oop.yml

ansible-playbook playbooks/scenarios/all_in_one/deploy.yml --limit openop_1

```



!!! warning "Specify a limit if several host in your environment"

    If you have several hosts in the inventory, make sure you limit the deployment to a single host, for example `--limit openop_1`. If not, all-in-one deployment will be installed in all your nodes.



For deployments requiring credentials:



```bash

ansible-playbook playbooks/scenarios/deploy_quick_single_oop.yml -e @secrets.yml

ansible-playbook playbooks/scenarios/all_in_one/deploy.yml --limit openop_1 -e @secrets.yml

```



## Step-by-Step Guide
@@ -64,6 +68,7 @@ ansible kind_cluster -m ping 
```



Expected output:



```

your_host | SUCCESS => {

    "changed": false,
@@ -84,29 +89,15 @@ ansible-playbook playbooks/00-setup-docker.yml 
Run the quick single OOP scenario:



```bash

ansible-playbook playbooks/scenarios/deploy_quick_single_oop.yml

ansible-playbook playbooks/scenarios/all_in_one/deploy.yml --limit openop_1

```



If you need registry credentials (for Lite2Edge):



```bash

ansible-playbook playbooks/scenarios/deploy_quick_single_oop.yml -e @secrets.yml

ansible-playbook playbooks/scenarios/all_in_one/deploy.yml --limit openop_1 -e @secrets.yml

```



### Step 5: Monitor Progress



The playbook will show progress through several stages:



1. **Setup** - Installing prerequisites (Python, Docker, kubectl)

2. **Infrastructure** - Creating Kind cluster, installing NFD, Prometheus

3. **Services** - Deploying Zot, Artefact Manager, Federation Managers

4. **Edge Platform** - Installing Lite2Edge

5. **Dashboard** - Deploying Homer dashboard



Typical deployment time: **5-8 minutes**



## What Gets Deployed



| Component | Description | Access |

|-----------|-------------|--------|

| **Kind Cluster** | Kubernetes cluster | `kubectl` with generated kubeconfig |
@@ -132,10 +123,12 @@ The dashboard provides one-click access to all deployed services. 
### Default Credentials



**Zot:**



- No authentication required by default

- Can be configured in `ansible/inventory/group_vars/all/zot.yml`



**Grafana:**



- Username: `admin`

- Password: `prom-operator` (default from kube-prometheus-stack)
@@ -208,6 +201,7 @@ sudo lsof -i :6443 # or whatever port is conflicted 
```



Either:



- Stop the conflicting service

- Change the port mapping in `group_vars/all.yml`
@@ -221,6 +215,7 @@ kubectl describe pod <pending-pod> -n <namespace> 
```



Consider:



- Using a more powerful VM

- Reducing worker nodes

- Not deploying all components
@@ -230,10 +225,11 @@ Consider: 
To remove the entire deployment:



```bash

ansible-playbook playbooks/infrastructure/kind-cluster/undeploy.yml

aplaybooks/scenarios/all_in_one/quick_undeploy.yml --limit openop_1

```



This will:



- Delete the Kind cluster

- Remove generated kubeconfig

- Clean up resources