mirror of
https://github.com/kerberos-io/documentation.git
synced 2026-08-23 15:18:31 +00:00
rewrite vault section and add new graphics
This commit is contained in:
@@ -34,17 +34,11 @@
|
||||
identifier = "hub"
|
||||
url = "/hub/"
|
||||
|
||||
# [[main]]
|
||||
# name = "Quickstart"
|
||||
# url = "/prologue/introduction/"
|
||||
# weight = 10
|
||||
|
||||
[[main]]
|
||||
name = "Homepage"
|
||||
url = "https://kerberos.io"
|
||||
weight = 12
|
||||
|
||||
|
||||
[[social]]
|
||||
name = "Twitter"
|
||||
pre = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"20\" height=\"20\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\" class=\"feather feather-twitter\"><path d=\"M23 3a10.9 10.9 0 0 1-3.14 1.53 4.48 4.48 0 0 0-7.86 3v1A10.66 10.66 0 0 1 3 4s-4 9 5 13a11.64 11.64 0 0 1-7 2c9 5 20 0 20-11.5a4.5 4.5 0 0 0-.08-.83A7.72 7.72 0 0 0 23 3z\"></path></svg>"
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Enterprise"
|
||||
title: "Vault"
|
||||
description: ""
|
||||
lead: ""
|
||||
date: 2020-10-06T08:49:15+00:00
|
||||
|
||||
@@ -13,64 +13,74 @@ weight: 300
|
||||
toc: true
|
||||
---
|
||||
|
||||
Kerberos Opensource and Kerberos Enterprise both store recordings on the local disk. To centralise your data at a single place, additional solutions are available.
|
||||
It all starts with your Kerberos Agents. You might set up one or more agents at several locations, sites, rooms, offices, etc. Each Kerberos Agent will monitor a particular video stream and persist recordings on a local disk; taking into account the specific conditions such as region of interest, time window, etc.
|
||||
|
||||
#### Kerberos Hub
|
||||
While growing your video landscape, and adding more and more Kerberos Agents, it will become interesting, and probably also required to have a central place of storage. That central place might be at the edge, in the cloud, or both depending on the uses.
|
||||
|
||||
One or more Kerberos Enterprise agents, can store their data directly on [Kerberos Hub](/hub/first-things-first), and benefit from the visualisation layer Kerberos Hub offers. When doing this your recordings will be uploaded inside the Kerberos datacenter (which is a black box for you).
|
||||
{{< figure src="vault-edge-cloud-storage.svg" alt="Bring your own storage using Vault" caption="Bring your own storage using Kerberos Vault" class="stretch">}}
|
||||
|
||||
#### Kerberos Vault
|
||||
That central storage place is what we call Kerberos Vault. It allows you to store your data wherever you want, and let you integrate with any kind of process such as machine learning, event systems, CCTV monitoring, etc.
|
||||
|
||||
In addition to that you have the option to Bring Your Own Storage (BYOS), using Kerberos Vault. Kerberos Vault allows you to configure the storage providers you want, and allows you to connect to [Kerberos Hub](/hub/first-things-first) in parrallel. These storage provider could live in the cloud such as AWS S3, GCP storage and Azure Blob store, or can be located on premise - at the edge - such as Minio.
|
||||
## Kerberos Vault in a nutshell
|
||||
|
||||
Kerberos Vault is a solution where you Bring Your Own Storage (BYOS). It allows you to configure the storage providers you want, and makes it possible to connect consuming applications such as [Kerberos Hub](/hub/first-things-first), Machine learning models, Kafka brokers, etc. As discussed before, these so-called storage providers can live in the cloud such as Amazon Web Services S3, Google Cloud Platform Storage, Storj, or reside at the edge such as Minio or Ceph.
|
||||
|
||||
Despite the flexible storage capabilities, Kerberos Vault is also an open platform, which can be used to build extensions (mobile apps, web apps, machine learning services, etc) and integrations. It allows you to leverage a scalable and stable system as a strong backbone for your video analytics solutions, machine learning algorithms, and more.
|
||||
|
||||
## Kerberos Hub
|
||||
## Storage Providers
|
||||
|
||||
Within Kerberos Opensource and Kerberos Enterprise you can upload your recordings to our public [Kerberos Hub](/hub/first-things-first) environment. This means that your data will be hosted and processed (metadata) in our Kerberos Vault (datacenteR). For more information about how Kerberos Hub works [can be found here](/hub/first-things-first).
|
||||
|
||||
{{< figure src="arch-kerberos-hub.svg" alt="Store your recordings in Kerberos Hub" caption="Store your recordings in Kerberos Hub" class="stretch">}}
|
||||
|
||||
## Kerberos Vault
|
||||
|
||||
If you are using Kerberos Enterprise you have the possibility to bring your own cloud storage or on premise storage. By installing Kerberos Vault you can send your recordings to your own datacenter, private or public cloud. Following providers are supported:
|
||||
When deploying Kerberos Agents you have the possibility to Bring Your Own Storage; at the edge or in the cloud. By configuring Kerberos Vault you persist your recordings in your preferred storage providers. Following providers are supported:
|
||||
|
||||
- [Google Cloud Platform Storage](https://cloud.google.com/storage)
|
||||
- [Microsoft Azure Storage](https://azure.microsoft.com/en-us/services/storage/)
|
||||
- [Amazon Web Services S3](https://aws.amazon.com/s3/)
|
||||
- [Storj](https://storj.io/)
|
||||
- [Minio](https://min.io/)
|
||||
- [Ceph](https://ceph.io/)
|
||||
|
||||
When installing Kerberos Vault in the cloud, following architecture can apply. Having your Kerberos Enterprise agents running at the edge, but uploading to Kerberos Vault in the cloud.
|
||||
When installing Kerberos Vault in a cloud environment, following architecture may apply. Your Kerberos Agents are running at the edge, but uploading to Kerberos Vault in a cloud environment.
|
||||
|
||||
{{< figure src="arch-kerberos-vault-providers.svg" alt="Bring your own storage using Kerberos Vault" caption="Bring your own storage using Kerberos Vault" class="stretch">}}
|
||||
{{< figure src="vault-cloud-storage.svg" alt="Bring your own storage using Kerberos Vault" caption="Bring your own storage using Kerberos Vault" class="stretch">}}
|
||||
|
||||
On the other hand you could also have Kerberos Vault running at the edge, next to your Kubernetes Enterprise agents. This could be useful if you want to do processing or video analytics such as computer vision or machine learning at the edge.
|
||||
|
||||
{{< figure src="arch-edge-kerberos-vault.svg" alt="Store your recordings at the edge with Kerberos Vault" caption="Store your recordings at the edge with Kerberos Vault" class="stretch">}}
|
||||
{{< figure src="vault-edge-storage.svg" alt="Store your recordings at the edge with Kerberos Vault" caption="Store your recordings at the edge with Kerberos Vault" class="stretch">}}
|
||||
|
||||
### Events
|
||||
### Integration and Events
|
||||
|
||||
One of the key differentiators compared to other VMS solutions, is the abilitity to extend and integrate. Next to uploading and persisting data, Kerberos Vault can also trigger events. Each time a recording is send to Kerberos Vault an event can be triggered through one of the following providers.
|
||||
One of the key differentiators, is the ability to extend and integrate. Next to uploading and persisting recordings on your preferred storage providers, Kerberos Vault can trigger events and be configured through APIs.
|
||||
|
||||
Each time a Kerberos Agent sends a recording to Kerberos Vault, it is persisted on a storage provider, and an event is triggered through one of the following integrations.
|
||||
|
||||
- [Apache Kafka](https://kafka.apache.org/)
|
||||
- [Amazon Web Services SQS](https://aws.amazon.com/sqs/)
|
||||
- [Kerberos Hub](/hub/first-things-first/)
|
||||
- Kerberos Vault (remote forwarding)
|
||||
|
||||
Those events can be fetched or subscribed by custom applications. For example, one can create a notifications service, machine learning service or an entire cloud application. Allowing you to leverage the power and scalability of Kerberos Enterprise, and building and focussing on your specific applications, API's, mobile apps, or whatever you have in mind to build.
|
||||
Every time an event is delivered, it will be consumed by the configured integrations. For example in case of a Kafka integration, you could build a Kafka consumer with custom application logic; a notification manager, a machine learning service, etc.
|
||||
|
||||
{{< figure src="arch-kerberos-vault-events.svg" alt="Build integrations and create your own workflows using the event capability of Kerberos Vault." caption="Build integrations and create your own workflows using the event capability of Kerberos Vault." class="stretch">}}
|
||||
Find more information about events and integrations on [the integrations page](/vault/integrations).
|
||||
|
||||
### On-demand upload
|
||||
{{< figure src="vault-integrations.svg" alt="Build integrations and create your own workflows using the event capability of Kerberos Vault." caption="Build integrations and create your own workflows using the event capability of Kerberos Vault." class="stretch">}}
|
||||
|
||||
Next to the extension and integration capabilities of Kerberos Vault, it is also possible to synchronise with a central Kerberos Vault. On-Demand upload allows you to synchronise a subset of your recording with an additional Kerberos Vault in the cloud.
|
||||
### Machine learning and Computer Vision
|
||||
|
||||
{{< figure src="arch-sync-kerberos-vault.svg" alt="Synchronise recordings between multiple Kerberos Vault" caption="Synchronise recordings between multiple Kerberos Vault" class="stretch">}}
|
||||
Kerberos Vault allows scaling machine learning and computer vision algorithms through the concept of queueing, decoupling of Kerberos Agents to recordings and NVidia Kubernetes Operator.
|
||||
|
||||
A couple of usecases are the following ones:
|
||||
Kerberos Agents send recordings to Kerberos Vault. Every time a recording is stored, the Kafka integration is producing an event in a Kafka topic. A machine learning or computer vision consumer is reading from a Kafka topic, downloads the relevant recording from Kerberos Vault, and starts a prediction or execution of an algorithm on one or more GPUs.
|
||||
|
||||
- Continious recording: having continious recordings stored in your Kerberos Vault on premise, you don't want to replicate all your recordings to a Kerberos Vault provider in the cloud (to make them public available). Therefore you could implement custom logic, for example based on a machine learning algorithm, to only replicate recordings which matche a specific scenario.
|
||||
By combining the intelligence of making recordings in small chunks, and distributing them across multiple GPUs, we allow you to scale your machine learning or computer vision independent of the number of video streams. Learn more about developing your own [machine learning model or computer vision algorithm](/vault/machine-learning/).
|
||||
|
||||
- On-Demand request: Having Kerberos Hub, an end-user could initiate a request for upload. By default no recordings are forwarded from your Kerberos Vault on premise to your Kerberos Vault in the cloud. Only when an end user requests one or more recordings, the
|
||||
upload will start for the requested recordings.
|
||||
{{< figure src="vault-ml-cv.svg" alt="Machine learning and Computer Vision with Kerberos Vault." caption="Machine learning and Computer Vision with Kerberos Vault" class="stretch">}}
|
||||
|
||||
### Remote forwarding and chaining
|
||||
|
||||
Multiple Kerberos Vaults can be installed in your video landscape. You may have Kerberos Vaults at the edge and/or in a cloud environment, connected to edge and/or cloud storage providers.
|
||||
|
||||
Kerberos Vaults can be chained and configured in forwarding mode. This configuration makes it possible to enable offline capabilities and keep the majority of your recordings at the edge. Only a subset of your recordings will be transferred from the edge to the cloud by requesting a forward from Kerberos Hub or building your own forwarding application code.
|
||||
|
||||
{{< figure src="vault-forwarding-chaining.svg" alt="Synchronise recordings between multiple Kerberos Vault" caption="Synchronise recordings between multiple Kerberos Vault" class="stretch">}}
|
||||
|
||||
An example of remote forwarding is a machine learning filter. Recordings are stored in a Kerberos Vault at the edge, and are processed by a machine learning model. Every time the machine learning model finds a match, e.g. a pedestrian detected, it will forward the recording to Kerberos Vault in a cloud environment. By doing this you will send limited recordings (storage) into the cloud.
|
||||
|
||||
### Open API
|
||||
|
||||
@@ -80,4 +90,4 @@ Both Kerberos Enterprise as Kerberos Vault ships with Swagger API's, which can b
|
||||
|
||||
## Licensing
|
||||
|
||||
Kerberos Vault is publicly available and **requires a license key** to operate correctly. Reach out to **cedric@kerberos.io** for the commercial matters.
|
||||
Kerberos Vault is shipped as a binary in a Docker container and is licensed through the MIT license. The source code is closed, and maintained by the Kerberos.io development team.
|
||||
|
||||
568
content/vault/first-things-first/vault-cloud-storage.svg
Normal file
568
content/vault/first-things-first/vault-cloud-storage.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 109 KiB |
627
content/vault/first-things-first/vault-edge-cloud-storage.svg
Normal file
627
content/vault/first-things-first/vault-edge-cloud-storage.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 131 KiB |
528
content/vault/first-things-first/vault-edge-storage.svg
Normal file
528
content/vault/first-things-first/vault-edge-storage.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 101 KiB |
587
content/vault/first-things-first/vault-forwarding-chaining.svg
Normal file
587
content/vault/first-things-first/vault-forwarding-chaining.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 471 KiB |
575
content/vault/first-things-first/vault-integrations.svg
Normal file
575
content/vault/first-things-first/vault-integrations.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 229 KiB |
559
content/vault/first-things-first/vault-ml-cv.svg
Normal file
559
content/vault/first-things-first/vault-ml-cv.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 461 KiB |
16
content/vault/integrations/index.md
Normal file
16
content/vault/integrations/index.md
Normal file
@@ -0,0 +1,16 @@
|
||||
---
|
||||
title: "Integrations"
|
||||
description: ""
|
||||
lead: ""
|
||||
date: 2020-10-06T08:49:31+00:00
|
||||
lastmod: 2020-10-06T08:49:31+00:00
|
||||
draft: false
|
||||
images: []
|
||||
menu:
|
||||
vault:
|
||||
parent: "vault"
|
||||
weight: 306
|
||||
toc: true
|
||||
---
|
||||
|
||||
ypp
|
||||
21
content/vault/machine-learning/index.md
Normal file
21
content/vault/machine-learning/index.md
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
title: "Machine learning"
|
||||
description: ""
|
||||
lead: ""
|
||||
date: 2020-10-06T08:49:31+00:00
|
||||
lastmod: 2020-10-06T08:49:31+00:00
|
||||
draft: false
|
||||
images: []
|
||||
menu:
|
||||
vault:
|
||||
parent: "vault"
|
||||
weight: 306
|
||||
toc: true
|
||||
---
|
||||
|
||||
A couple of uses are the following ones:
|
||||
|
||||
- Continuous recording: having continuous recordings stored in your Kerberos Vault on premise, you don't want to replicate all your recordings to a Kerberos Vault provider in the cloud (to make them public available). Therefore, you could implement custom logic, for example based on a machine learning algorithm, to only replicate recordings which matche a specific scenario.
|
||||
|
||||
- On-Demand request: Having Kerberos Hub, an end-user could initiate a request for upload. By default no recordings are forwarded from your Kerberos Vault on premise to your Kerberos Vault in the cloud. Only when an end user requests one or more recordings, the
|
||||
upload will start for the requested recordings.
|
||||
21
content/vault/remote-forwarding/index.md
Normal file
21
content/vault/remote-forwarding/index.md
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
title: "Remote forwarding"
|
||||
description: ""
|
||||
lead: ""
|
||||
date: 2020-10-06T08:49:31+00:00
|
||||
lastmod: 2020-10-06T08:49:31+00:00
|
||||
draft: false
|
||||
images: []
|
||||
menu:
|
||||
vault:
|
||||
parent: "vault"
|
||||
weight: 306
|
||||
toc: true
|
||||
---
|
||||
|
||||
A couple of uses are the following ones:
|
||||
|
||||
- Continuous recording: having continuous recordings stored in your Kerberos Vault on premise, you don't want to replicate all your recordings to a Kerberos Vault provider in the cloud (to make them public available). Therefore, you could implement custom logic, for example based on a machine learning algorithm, to only replicate recordings which matche a specific scenario.
|
||||
|
||||
- On-Demand request: Having Kerberos Hub, an end-user could initiate a request for upload. By default no recordings are forwarded from your Kerberos Vault on premise to your Kerberos Vault in the cloud. Only when an end user requests one or more recordings, the
|
||||
upload will start for the requested recordings.
|
||||
@@ -1 +0,0 @@
|
||||
!function(e,t){for(var n in t)e[n]=t[n]}(exports,function(e){var t={};function n(r){if(t[r])return t[r].exports;var o=t[r]={i:r,l:!1,exports:{}};return e[r].call(o.exports,o,o.exports,n),o.l=!0,o.exports}return n.m=e,n.c=t,n.d=function(e,t,r){n.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:r})},n.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.t=function(e,t){if(1&t&&(e=n(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var r=Object.create(null);if(n.r(r),Object.defineProperty(r,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)n.d(r,o,function(t){return e[t]}.bind(null,o));return r},n.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return n.d(t,"a",t),t},n.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n.p="",n(n.s=0)}([function(e,t){t.handler=(e,t,n)=>{n(null,{statusCode:200,headers:{"Content-Type":"application/json"},body:JSON.stringify({message:"Hi from Lambda."})})}}]));
|
||||
@@ -1,6 +1,6 @@
|
||||
name = "Kerberos.io"
|
||||
license = "MIT"
|
||||
description = "Kerberos.io is a scalable and cloud agnostic video surveillance and analytics system, which is open for integrations."
|
||||
description = "Kerberos.io is a scalable and cloud agnostic video and analytics solution."
|
||||
homepage = "https://doc.kerberos.io/"
|
||||
tags = ["kerberos.io", "video surveillance", "video analytics", "scalable"]
|
||||
features = ["scalable", "high available", "docker", "kubernetes", "opensource", "bring your own storage", "on premise video surveillance"]
|
||||
|
||||
Reference in New Issue
Block a user