Skip to content

Commit

Permalink
Merge pull request #6 from epic-gateway/installation-guides
Browse files Browse the repository at this point in the history
initial installation guides
  • Loading branch information
adamdunstan authored Nov 6, 2023
2 parents eb99939 + d81f8ae commit fd450fa
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 2 deletions.
2 changes: 1 addition & 1 deletion content/gateway_service/user_manual/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 10
EPIC is a Gateway for Kubernetes. It uses the *new* gateway API to simplify the administration and creation of API and Application Gateways. The Gateway, EPIC, works with the EPIC Gateway Controller installed on the k8s cluster.

<p align="center">
<img src="./gwsm-working.png" style="width:600px">
<img src="gwsm-working.png" style="width:600px">
</p>


Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion content/gateway_service/user_usecase/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Use Cases"
linkTitle: "Use Cases"
weight: 30
weight: 20
---
59 changes: 59 additions & 0 deletions content/quick_start/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: "Vagrant based Test & Development"
linkTitle: "Quick Start (Dev & Test)"
weight: 30
description: >
Quick start using Vagrant to create EPIC & workload cluster
---

The [dev-test-environment](https://github.com/epic-gateway/dev-test-environment) repo contain prebuilt vagrant environment and is an easy way to try the EPIC platform. There are two variants, single and multi-node, single node is recommended as a starting point.



## Prerequisites

* Linux host with KVM
* Vagrant with qemu-kvm support
* Ansible version 2.11 or later

*We have used this with Debian and Ubuntu*

## Single Node
The Single Node environment consists of one EPIC gateway and one workload cluster. The vagrant scripts for each installs all of the the necessary components.


```bash
vagrant up gateway
```
The script creates the VM, then installs and configures all of the EPIC components, this script can take sometime to run.


```bash
vagrant up gwclient
```

This script creates a VM with a single k8s node and installed the Gateway Controller.


## Multinode
The multinode is more representative of a production environment.


```mermaid
graph LR
net2 --- R1[router] --- net1
net1 --- E1[EPIC Node 1]
net1 --- E2[EPIC Node 2]
net1 --- E3[EPIC Node 3]
net1 --- K1[k8s node 1]
net1 --- K2[k8s node 2]
net1 --- K3[k8s node 3]
net2([net brext0])
net1([net user-epic0])
```

Scripts are provided to create a router vm using frr, 3 node EPIC cluster and 3 node workload cluster. It requires an additional linux bridge to be configured to operate.

The scripts and instructions are available in the [multinode directory](https://github.com/epic-gateway/dev-test-environment/tree/main/multinode)

0 comments on commit fd450fa

Please sign in to comment.