Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
marc-barry committed Nov 28, 2023
1 parent 0d0588d commit 4a2684c
Showing 1 changed file with 23 additions and 8 deletions.
31 changes: 23 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
# qtap-operator

A kubernetes operator to simplify routing outbound traffic through Qpoint's 3rd-party API Gateway

## Install

Helm

```
todo
```text
helm install qtap-operator qpoint/qtap-operator --namespace qpoint
```

Manual

```
todo
```

The pre-built Docker container can be found at us-docker.pkg.dev/qpoint-edge/public/kubernetes-qtap-operator and uses the tag for the release <https://github.com/qpoint-io/kubernetes-qtap-operator/releases>. See <https://github.com/qpoint-io/helm-charts/blob/main/charts/qtap-operator/templates/deployment.yaml> for an example of a Deployment.

## Configure Egress

__Option 1:__ Namespace label

```
```text
kubectl label namespace <namespace> qpoint-egress=enabled
```

__Option 2:__ Pod annotation

```
```text
apiVersion: v1
kind: Pod
metadata:
Expand All @@ -34,11 +34,26 @@ metadata:
qpoint.io/egress: enabled
```

The order of precedence is that a pod annotation can override a namespace label. For example the following would enable for a namespace but disable for a pod.

```text
kubectl label namespace <namespace> qpoint-egress=enabled
```

```text
apiVersion: v1
kind: Pod
metadata:
name: hello-world
annotations:
qpoint.io/egress: disabled
```

## Local Dev

Bootstrap dev cluster (uses KinD) with live-reloading

```
```text
make dev
```

Expand Down

0 comments on commit 4a2684c

Please sign in to comment.