Skip to content
This repository was archived by the owner on Dec 9, 2024. It is now read-only.

Commit 02e8f5f

Browse files
authored
documentation for running event-gateway on k8s (#498)
* adding more changes to README * interim commit for more README updates * more updates to README * adding in fedora section * moving README one level higher * adding in ports description * breaking up lines a bit * fixing the event url * adding in dev flag for running * adding example function register * updating data * updating for typo * cleaning up k8s content * updating based on feedback * interim commit for k8s * cleaning up helm files * moving to template variables * initial commit minikube readme * updating README * updating number * updating formatting * more formatting * updating based upon feedback * updating with trigger * updating the TOC * updating based upon further feedback * updating with more feedback * updating to query all event types * updating the README for the contrib level folder * updating to builleted items * removing extraneous reference * updating README with feedback * cleaning up doublenote
1 parent 8b31577 commit 02e8f5f

File tree

10 files changed

+451
-2634
lines changed

10 files changed

+451
-2634
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ If you don't want to run the Event Gateway yourself, you can use the hosted vers
7373
There is a [official Docker image](https://hub.docker.com/r/serverless/event-gateway/).
7474

7575
```bash
76-
docker run -p 4000:4000 -p 4001:4001 serverless/event-gateway -dev
76+
docker run -p 4000:4000 -p 4001:4001 serverless/event-gateway --dev
7777
```
7878

7979
### Binary
@@ -89,9 +89,14 @@ On Windows download [binary](https://github.com/serverless/event-gateway/release
8989
Then run the binary in development mode with:
9090

9191
```bash
92-
$ event-gateway -dev
92+
$ event-gateway --dev
9393
```
9494

95+
### Kubernetes
96+
97+
The repo contains `helm` [charts](contrib/helm/README.md) for a quick deploy to an existing cluster using native nginx Ingress. To deploy
98+
a development cluster you can follow the [minikube](contrib/helm/MINIKUBE.md) instructions.
99+
95100
---
96101

97102
If you want more detailed information on running and developing with the Event Gateway,

contrib/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Event Gateway Contributions
2+
3+
This folder contains services and contributions which complement the Event Gateway.
4+
5+
+ Install Event Gateway on Kubernetes using [helm](helm/README.md)
6+
+ Provision the Event Gateway on AWS ECS Fargate using [terraform](terraform/README.md)

contrib/helm/MINIKUBE.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Install Minikube for Local Development
2+
3+
To develop and deploy the `event-gateway` and all related elements locally, the easiest method includes using
4+
the [minikube](https://github.com/kubernetes/minikube) toolset. To get started, set up your local cluster with the
5+
following instructions...
6+
7+
## Contents
8+
1. [Fedora/RHEL/CentOS](#fedora-rhel-centos)
9+
1. [Debian/Ubuntu](#debian-ubuntu)
10+
1. [MacOS](#macos)
11+
12+
### Fedora/RHEL/CentOS
13+
+ Install the prerequisite packages:
14+
```bash
15+
sudo dnf install kubernetes libvirt-daemon-kvm qemu-kvm nodejs docker
16+
```
17+
18+
+ Ensure your user is added to the `libvirt` group for VM access. You can verify with `getent group libvirt` once done.
19+
```bash
20+
sudo usermod -a -G libvirt $(whoami)
21+
```
22+
23+
+ Next, add the `libvirt` group to your current user grouplist. Verify by running `id` once done.
24+
```bash
25+
newgrp libvirt
26+
```
27+
28+
+ Add the [docker-machine](https://github.com/docker/machine) binary to your system
29+
```bash
30+
curl -L https://github.com/docker/machine/releases/download/v0.15.0/docker-machine-$(uname -s)-$(uname -m) >/tmp/docker-machine && \
31+
chmod +x /tmp/docker-machine && \
32+
sudo cp /tmp/docker-machine /usr/local/bin/docker-machine
33+
```
34+
35+
+ Add the CentOS `docker-machine` kvm driver. It's ok if you're not using CentOS as the driver should **still work**™
36+
```bash
37+
sudo curl -L https://github.com/dhiltgen/docker-machine-kvm/releases/download/v0.10.0/docker-machine-driver-kvm-centos7 > /tmp/docker-machine-driver-kvm && \
38+
sudo chmod +x /tmp/docker-machine-driver-kvm && \
39+
sudo mv /tmp/docker-machine-driver-kvm /usr/local/bin/docker-machine-driver-kvm
40+
```
41+
42+
+ Download the minikube instance for your system
43+
```bash
44+
curl -Lo minikube https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 && \
45+
sudo chmod +x minikube && \
46+
sudo mv minikube /usr/local/bin/
47+
```
48+
49+
+ Finally, start up your minikube service! **NOTE:** the instructions recommend using `kvm2` but please use the version that matches your system install
50+
```bash
51+
minikube start --vm-driver kvm2
52+
```
53+
54+
+ Once everything is running you should be able to view your running cluster status
55+
```bash
56+
minikube status
57+
minikube service kubernetes-dashboard --namespace kube-system
58+
```
59+
60+
### Debian/Ubuntu
61+
62+
PENDING
63+
64+
### MacOS
65+
66+
PENDING

0 commit comments

Comments
 (0)