Skip to content

Commit

Permalink
fix: updates to quickstart
Browse files Browse the repository at this point in the history
Signed-off-by: Evan Baker <[email protected]>
  • Loading branch information
rbtr committed Mar 15, 2024
1 parent 016dce9 commit 1f0b64c
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 12 deletions.
11 changes: 3 additions & 8 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -397,10 +397,9 @@ manifests:

# basic/node-level mode
helm-install: manifests
helm install retina ./deploy/manifests/controller/helm/retina/ \
helm upgrade --install retina ./deploy/manifests/controller/helm/retina/ \
--namespace kube-system \
--set image.repository=$(IMAGE_REGISTRY)/$(RETINA_IMAGE) \
--set image.tag=$(RETINA_PLATFORM_TAG) \
--set image.initRepository=$(IMAGE_REGISTRY)/$(RETINA_INIT_IMAGE) \
--set image.pullPolicy=Always \
--set logLevel=info \
Expand All @@ -410,17 +409,15 @@ helm-install: manifests

# advanced/pod-level mode with scale limitations, where metrics are aggregated by source and destination Pod
helm-install-advanced-remote-context: manifests
helm install retina ./deploy/manifests/controller/helm/retina/ \
helm upgrade --install retina ./deploy/manifests/controller/helm/retina/ \
--namespace kube-system \
--set image.repository=$(IMAGE_REGISTRY)/$(RETINA_IMAGE) \
--set image.tag=$(RETINA_PLATFORM_TAG) \
--set image.initRepository=$(IMAGE_REGISTRY)/$(RETINA_INIT_IMAGE) \
--set image.pullPolicy=Always \
--set logLevel=info \
--set os.windows=true \
--set operator.enabled=true \
--set operator.enableRetinaEndpoint=true \
--set operator.tag=$(RETINA_PLATFORM_TAG) \
--set operator.repository=$(IMAGE_REGISTRY)/$(RETINA_OPERATOR_IMAGE) \
--skip-crds \
--set enabledPlugin_linux="[\"dropreason\"\,\"packetforward\"\,\"linuxutil\"\,\"dns\",\"packetparser\"\]" \
Expand All @@ -429,17 +426,15 @@ helm-install-advanced-remote-context: manifests

# advanced/pod-level mode designed for scale, where metrics are aggregated by "local" Pod (source for outgoing traffic, destination for incoming traffic)
helm-install-advanced-local-context: manifests
helm install retina ./deploy/manifests/controller/helm/retina/ \
helm upgrade --install retina ./deploy/manifests/controller/helm/retina/ \
--namespace kube-system \
--set image.repository=$(IMAGE_REGISTRY)/$(RETINA_IMAGE) \
--set image.tag=$(RETINA_PLATFORM_TAG) \
--set image.initRepository=$(IMAGE_REGISTRY)/$(RETINA_INIT_IMAGE) \
--set image.pullPolicy=Always \
--set logLevel=info \
--set os.windows=true \
--set operator.enabled=true \
--set operator.enableRetinaEndpoint=true \
--set operator.tag=$(RETINA_PLATFORM_TAG) \
--set operator.repository=$(IMAGE_REGISTRY)/$(RETINA_OPERATOR_IMAGE) \
--skip-crds \
--set enabledPlugin_linux="[\"dropreason\"\,\"packetforward\"\,\"linuxutil\"\,\"dns\",\"packetparser\"\]" \
Expand Down
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,15 @@ Retina is currently supported in AKS. It has two major features:

### Quick Install Guide

1. Create a Kubernetes cluster with a minimum of 2 nodes. Retina supports Linux (Ubuntu) and Windows (2019 and 2022) nodes.
2. Follow steps in [Using Managed Prometheus and Grafana](https://retina.sh/docs/installation/prometheus-azure-managed)
Prerequisites: Go, Helm

1. Clone the repo, then install Retina on your Kubernetes cluster

```bash
make helm-install
```

2. Follow steps in [Using Managed Prometheus and Grafana](https://retina.sh/docs/installation/prometheus-azure-managed) to set up metrics collection and visualization.

### Captures

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ spec:
- name: bpf
mountPath: /sys/fs/bpf
mountPropagation: Bidirectional
{{- range $name, $mountPath := .Values.volumeMounts }}
- name: {{ $name }}
mountPath: {{ $mountPath }}
{{- end }}
containers:
- name: {{ include "retina.name" . }}
livenessProbe:
Expand Down
4 changes: 2 additions & 2 deletions deploy/manifests/controller/helm/retina/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ apiServer:
# Supported - debug, info, error, warn, panic, fatal.
logLevel: debug

enabledPlugin_linux: '["dropreason","packetforward","linuxutil", "dns"]'
enabledPlugin_linux: '["dropreason","packetforward","linuxutil","dns"]'
enabledPlugin_win: '["hnsstats"]'

enableTelemetry: true
Expand Down Expand Up @@ -84,7 +84,7 @@ volumeMounts:
tmp: /tmp
config: /retina/config

#volume mounts for indows
#volume mounts for windows
volumeMounts_win:
retina-config-win: retina

Expand Down

0 comments on commit 1f0b64c

Please sign in to comment.