# Get Started - Kerberos Docs

# Get Started

What to expect from the Kerberos Enterprise agent.

Once you’ve installed Kerberos Enterprise, you will have the Kerberos Enterprise Factory webapp running inside your cluster. This web application allows you to administrate your Kerberos Enterprise agents as deployments/pods. It comes a bunch of other features as well, read on.

Important to note is that this web app is relying on the Golang Kubernetes SDK, so that means from an administration point of view, you could simply use the well known `kubectl` command. The webapp just add (a lot of) functionalities on top of the Kubernetes API, which are specific to Kerberos Enterprise agents.

## Login page#

Once you open a browser, and navigate to the Factory web application (see installation for the url), you will land on the login page.

Login into the Kerberos Enterprise agent interface.

The default username password of the Factory web applications is:

- username: root
- password: kerberos

> The username and password can be changed in the `deployment.yaml` file.

## Overview#

On the overview page you will find an intuitive overview of the different pages and functionalities. On the left menu you will see two sections: Docker and Kubernetes. Kerberos Enterprise can both run in Docker (single-host) and Kubernetes (cluster) mode, however the recommended way is of course Kubernetes.

When working with Kubernetes, Kerberos Enterprise agents are deployed as a deployment. When working with Docker, Kerberos Enterprise agents are deployed as traditional Docker containers.

Review your Docker or Kubernetes agents.

## Kubernetes#

On the left menu you will find the Kubernetes section. In this section 3 sub menu’s are available:

- Nodes: a list of all the nodes in your cluster.
- Deployments: a list of all the Kerberos Enterprise agents running in your cluster.
- Pods: all the pods running in your cluster.

## Nodes#

The nodes section lists all the available nodes inside your Kubernetes cluster. It shows a limited amount of information such as the version, the number of Docker images installed on the node, and some basic hardware information.

Get an entire list of nodes which are connected to your Kubernetes cluster.

## Deployments#

The deployments section will list all the Kerberos Enterprise agents (running as deployments) that you have deployed inside your cluster. This page gives you access to deploy new Kerberos Enterprise agents one by one or in bulk. Next to that you can easily upgrade Kerberos Enterprise agents to a newer version, reboot them, view logging and update the configuration options of the Kerberos Enterprise agent.

Get a list of all your Kerberos Enterprise agents.

### Adding a new deployment#

There are two options to add a new deployment, single deployments and bulk deployment.

Get a list of all your Kerberos Enterprise agents.

- single deployment

By specifying a name for your deployment, and it’s corresponding RTSP url, a new deployment will be created for you, and deployed to one of your installed nodes.

- in bulk deployment.

By importing an Excel file, deployments can be created in bulk.

By specifying the name and corresponding RTSP url in multiple rows, you can deploy your deployments in bulk.

Add a Kerberos Enterprise agent through a deployment.

### Configuring a deployment#

Once you have a running deployment, you should see a green circle next to the deployment, indicating that it is succesfully running. At any time you can configure your deployments by clicking on the icon. This will open a popup, allowing you to change some settings.

Once you created the Kerberos Enterprise agent, you can configure the agent.

Following settings can be changed:

- One or more regions of interest,
- Time based conditions,
- Pre- and postrecording
- Continious recording
- Linking to Kerberos Hub or Kerberos Vault

### Global configuration#

Configuration can be specified on a Kerberos Enterprise agent level, this means that you update the configuration of a specific deployment. However can also be specified at a higher level. This higher level is what we call the global configuration.

By specifying configurations at a higher level, any Kerberos Enterprise agents will inherit from that configuration, improving the overall maintenance and management of your Kerberos Enterprise agents.

You can specify the configurations on a global level, so all agents will inherit from that.

### Upgrade or reboot a Kerberos Enterprise agent#

At Kerberos.io we have fast development cycles, which means that new versions will be released every day, week or month. To make sure you can upgrade or downgrade your Kerberos Enterprise agent easily, an upgrade feature is built-in. When pressing the upgrade button, you will be able to select the version to which you would like to upgrade or downgrade. Once submitted, a zero downtime upgrade will take place. Kubernetes will download the new release, create a new pod, and destroy the old one.

At any moment you can reboot your Kerberos Enterprise agent. When pressing the reboot button, next to your deployment, Kubernetes will destroy the pod of your deployment, and schedule a new one. This comes in handy, when you noticed one of your Kerberos Enterprise agents is in a stale state.

You can specify the configurations on a global level, so all agents will inherit from that.

## Pods#

When creating a Kerberos Enterprise agent, Kubernetes will create a deployment and schedule a pod. This pod will be managed by your deployment, and deployed as a Docker container to one of your available nodes. Once a pod dies/ crashes, or whatever unexpected scenario, the deployment will make sure it is deployed again to a different (or the same) node. This makes sure the Kerberos Enterprise agent is in a healthy state at all times.

When creating a deployment, a Kubernetes pod has created and assigned to a node.

## Storage and video management#

Kerberos Enterprise allows you to scale your video landscape horizontally, using the concept of Kubernetes, and brings a strong backbone for stability and performance. It allows you to avoid reinventing the wheel, and get stuck in the numerious challenges of making an intelligent VMS yourself (we worked on this for 2 years with experienced engineers).

Kerberos Enterprise stores its recordings locally for a short amount of time. This means that long-term storage is not included in the solution. On top of that it also does not have a visual component, which allows you te review dashboards or recordings. To overcome these two challenges, long-term storage with extensibility/integration capabilities and visualisation features, following solutions were developed Kerberos Vault and Kerberos Hub.

### Kerberos Vault#

Kerberos Vault is a solution which makes it able to store recordings from Kerberos Enterprise agents (accross different clusters) at a central place, on the storage provider you want. You can store your recordings in the cloud (AWS S3, Google Cloud Storage, Azure Blob storage) or on premise (Minio).

On the other hand it’s an open platform, as it allows you build extensions and integrations (web apps, mobile apps, machine learning services much more). Kerberos Vault ships with the ability of real-time messaging (Kafka) and a REST API (documented as Swaggger).

Kerberos Vault allows you to centralise your recordings and build integrations.

To connect one or more Kerberos Enterprise agents to your Kerberos Vault instance, you should open the configuration option and navigate to the `cloud` tab. When selected you need to fill-in the credentials from your Kerberos Vault account.

- Storage URI: this is the API endpoint of your Kerberos Vault instance. Usually this is in the following format: `http(s)://api.yourdomain.com/storage`. Where `api.yourdomain.com` should match your Kerberos Vault API endpoint.

- Provider: the name of the provider, which you created on the Kerberos Vault providers page, to which you want to send your recordings to.

- Directory: this is the subdirectory in which your files will be stored. At the time of writing this should also equal your Kerberos Hub username, if you plan to upload to Kerberos Hub.

- Access Key: this should match the access key of one of your Kerberos Vault accounts.

- Secret Access Key: this should match the secret access key of one of your Kerberos Vault accounts.

Using Kerberos Vault you can bring your own storage, and store the recordings of your agents in your own storage provider.

### Kerberos Hub#

For the visualisation part Kerberos Hub comes into the picture. Kerberos Hub is a web app, backed up with a number of microservices, that shows dashboards, live streams, filter recordings and much more. Learn more about the features and functions here.

You have two choices when using Kerberos Hub, either you send your recordings from your Kerberos Enterprise agents directly to Kerberos Hub, or you send your recordings to Kerberos Vault, and connect Kerberos Vault to Kerberos Hub. About the latter more is explained on the Kerberos Vault page.

Select the Kerberos Hub option, and copy-paste the credentials from your Kerberos Hub subscription.

By linking your Enterprise agent to Kerberos Hub, your recordings and livestreams will become available online.

- Region: this is the region where your recordings will be stored. Only `eu-west-1` for now (will change, on the roadmap).

- Bucket: the name of the Kerberos Hub bucket. Only `kerberosaccept` for now (will change, on the roadmap).

- Directory: this is your personal directory, and matches your Kerberos Hub username.

- Public Key: this should match the public key of your Kerberos Hub subscription.

- Secret Access Key: this should match the private key of your Kerberos Hub subscription.

Edit this page on GitHub