Skip to content

Commit 91b00cd

Browse files
committed
feat: add detailed installation instructions and new image for AkôFlow setup
1 parent 90164b1 commit 91b00cd

2 files changed

Lines changed: 59 additions & 5 deletions

File tree

93.6 KB
Loading

docs/installation.md

Lines changed: 59 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
2+
---
23
title: 2 - Installation
34
description: Here you will find instructions on how to install AkôFlow in different environments, including local clusters and cloud platforms.
45
layout: page
56
---
67

78
## Software Requirements
89

9-
- **Operating System:** Linux, macOS or WSL2 (Windows Subsystem for Linux)
10+
- **Operating System:** Linux, macOS, or WSL2 (Windows Subsystem for Linux)
1011
- **Docker:** [Install Docker](https://docs.docker.com/get-docker/)
1112
- **kubectl:** [Install kubectl](https://kubernetes.io/docs/tasks/tools/)
1213
- **Kubernetes Cluster:** One of the following:
13-
- [Kind](https://kind.sigs.k8s.io/) (local)
14-
- Docker Desktop Kubernetes (enable Kubernetes in settings)
15-
- Cloud providers (e.g., EKS, GKE, AKS)
16-
14+
- [Kind](https://kind.sigs.k8s.io/) (local)
15+
- Docker Desktop Kubernetes (enable Kubernetes in settings)
16+
- Cloud providers (e.g., EKS, GKE, AKS)
1717

1818
## Quick Installation
1919

@@ -24,3 +24,57 @@ curl -fsSL https://akoflow.com/run | bash
2424

2525
AkôFlow will be available at `http://localhost:8080`.
2626

27+
## Setup on Local Kubernetes Cluster (Kind)
28+
29+
1. **Install Kind:**
30+
31+
Follow the instructions on the [Kind GitHub page](https://kind.sigs.k8s.io/docs/user/quick-start/) to install Kind.
32+
33+
2. **Create a Kind Cluster:**
34+
```bash
35+
kind create cluster --name akoflow-cluster
36+
```
37+
38+
**Check Host and Port of the Kubernetes API Server:**
39+
40+
You need to find the host and port of the Kubernetes API server to configure AkôFlow correctly. Run the following command:
41+
42+
```bash
43+
kubectl cluster-info --context kind-akoflow-cluster
44+
```
45+
Look for the line that says `Kubernetes control plane is running at ...`.
46+
47+
3. **Install AkôFlow in the Cluster:**
48+
49+
This resource file will set up services, deployments, config maps, and persistent volume claims necessary for AkôFlow to run in a local cluster.
50+
51+
```bash
52+
kubectl apply -f https://raw.githubusercontent.com/UFFeScience/akoflow/main/pkg/server/resource/akoflow-dev-dockerdesktop.yaml
53+
```
54+
55+
4. **Create Token for AkôFlow Engine to Access the Cluster:**
56+
57+
**Note:** The token duration is set to 800 hours. You can adjust it as needed.
58+
59+
```bash
60+
kubectl create token akoflow-server-sa --duration=800h --namespace=akoflow
61+
```
62+
63+
5. **Add Variables to `.env` File:**
64+
65+
AkôFlow will create a `.env` file in the `$HOME/akospace` directory. You need to add the following variables to the `.env` file:
66+
67+
```bash
68+
K8S_API_SERVER_HOST=host.docker.internal:58844
69+
K8S_API_SERVER_TOKEN=...your_token_here...
70+
71+
AKOFLOW_SERVER_SERVICE_SERVICE_HOST=host.docker.internal
72+
AKOFLOW_SERVER_SERVICE_SERVICE_PORT=8080
73+
```
74+
Replace `...your_token_here...` with the token you created in the previous step.
75+
**Note:** The host can be `localhost` or `host.docker.internal` depending on your Docker setup. The port should match the port of your Kubernetes API server.
76+
77+
6. **Restart AkôFlow:**
78+
79+
Restart the AkôFlow container and run the installation script again.
80+
![AkôFlow connected to local Kind cluster](assets/images/docs_runtime_connected.png "AkôFlow connected to local Kind cluster")

0 commit comments

Comments
 (0)