-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from epic-gateway/installation-guides
initial installation guides
- Loading branch information
Showing
4 changed files
with
61 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: "Use Cases" | ||
linkTitle: "Use Cases" | ||
weight: 30 | ||
weight: 20 | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |