Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 1.73 KB

getting_started.md

File metadata and controls

52 lines (33 loc) · 1.73 KB
Raw

Getting Started

This guide provides a step-by-step process for deploying SentryFlow in a Kubernetes environment, aimed at enhancing API observability. It includes detailed commands for each step along with their explanations.

Note: SentryFlow is currently in the early stages of development. Please be aware that the information provided here may become outdated or change without notice.

1. Prerequisites

  • A Kubernetes cluster running version 1.28 or later.
  • kubectl version 1.28 or later.

2. Deploying SentryFlow

Configure SentryFlow receiver by following this. Then deploy updated SentryFlow manifest by following kubectl command:

kubectl apply -f sentryflow.yaml

This will create a namespace named sentryflow and will deploy the necessary Kubernetes resources.

Then, check if SentryFlow is up and running by:

$ kubectl -n sentryflow get pods
NAME                         READY   STATUS    RESTARTS   AGE
sentryflow-cff887bbd-rljm7   1/1     Running   0          73s

3. Deploying SentryFlow Clients

SentryFlow has now been deployed in the cluster. In addition, SentryFlow exports API access logs through gRPC.

For testing purposes, a client has been developed.

  • log-client: Simply logs everything on STDOUT coming from SentryFlow.

It can be deployed into the cluster under namespace sentryflow by following the command:

kubectl apply -f https://raw.githubusercontent.com/5GSEC/SentryFlow/refs/heads/main/deployments/sentryflow-client.yaml

Then, check if it is up and running by:

kubectl get pods -n sentryflow

If you observe log-client, is running, the setup has been completed successfully.