Skip to content

Quick start

Installing Soveren is extremely simple:

  1. Install the Soveren Agent in your Kubernetes cluster

  2. Go to the Soveren app in the Soveren Cloud and start getting insights!

Installing the Agent

  1. Create a new Soveren token and have it handy for the following steps. The token identifies and authorizes your Agent within the Soveren Cloud.

  2. Create a namespace for Soveren installation:

    kubectl create namespace soverenio
    
    You can use any other valid namespace name instead of soverenio.

  3. Add the Soveren Helm repository:

    helm repo add soveren https://soverenio.github.io/helm-charts
    

  4. Install the Soveren Agent using the <TOKEN> that you obtained on the step 1:

    helm install -n soverenio soveren-agent soveren/soveren-agent --set digger.token="<TOKEN>"
    
    You can use any other valid release name instead of soveren-agent.

  5. That's it! You may go to the Soveren app now and check the dashboards.

For more advanced configuration options please take a look at the configuration page.

What happens under the hood

There are several things which happen automatically in the cluster when you install the Soveren Agent:

  1. Soveren Agent contains Interceptors and Personal Data Detector, which itself consists of several components.

  2. Both Interceptors and Personal Data Detector are deployed into the namespace soverenio.

  3. Soveren Agent reads a lot of relevant information from the Kubernetes API. For this, a dedicated ServiceAccount is created for Personal Data Detector. This ServiceAccount is given cluster-wide permissions (ClusterRoleBinding) to view.

  4. Interceptors do not need special Kubernetes RBAC permissions to capture the traffic.

  5. Interceptors read data from virtual network interfaces of the host. For this, the containers in which Interceptors are running require several things:

    1. privileged: true

    2. dnsPolicy: ClusterFirstWithHostNet

    3. hostNetwork: true

    4. hostPID: true