mirror of
https://github.com/kerberos-io/documentation.git
synced 2026-08-23 15:18:31 +00:00
11 lines
21 KiB
HTML
11 lines
21 KiB
HTML
<!doctype html><html lang=en-us><head><meta charset=utf-8><meta http-equiv=x-ua-compatible content="ie=edge"><meta name=viewport content="width=device-width,initial-scale=1,shrink-to-fit=no"><link rel=stylesheet href=https://doc.kerberos.io/main.5aa8061fdddcae33bf9aae606a659f783fca649c2a6c915897a14d1088493ae547064045e7ca5a43d69061955d449757d1bcb708760ae71f478384770974e798.css integrity="sha512-WqgGH93crjO/mq5gamWfeD/KZJwqbJFYl6FNEIhJOuVHBkBF58paQ9aQYZVdRJdX0by3CHYK5x9Hg4R3CXTnmA==" crossorigin=anonymous><noscript><style>img.lazyload{display:none}</style></noscript><meta name=robots content="index, follow"><meta name=googlebot content="index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1"><meta name=bingbot content="index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1"><title>First things first - Kerberos Docs</title><meta name=description content="Open and extensible video surveillance and analytics solution for everyone at any location."><link rel=canonical href=https://doc.kerberos.io/vault/first-things-first/><meta name=twitter:card content="summary_large_image"><meta name=twitter:image content="/doks.png"><meta name=twitter:title content="First things first"><meta name=twitter:description content="Kerberos Opensource and Kerberos Enterprise both store recordings on the local disk. To centralise your data at a single place, additional solutions are available.
|
|
Kerberos Hub One or more Kerberos Enterprise agents, can store their data directly on Kerberos Hub, 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).
|
|
Kerberos Vault In addition to that you have the option to Bring Your Own Storage (BYOS), using Kerberos Vault."><meta name=twitter:site content="@kerberosio"><meta name=twitter:creator content="@kerberosio"><meta property="og:title" content="First things first"><meta property="og:description" content="Kerberos Opensource and Kerberos Enterprise both store recordings on the local disk. To centralise your data at a single place, additional solutions are available.
|
|
Kerberos Hub One or more Kerberos Enterprise agents, can store their data directly on Kerberos Hub, 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).
|
|
Kerberos Vault In addition to that you have the option to Bring Your Own Storage (BYOS), using Kerberos Vault."><meta property="og:type" content="article"><meta property="og:url" content="/vault/first-things-first/"><meta property="og:image" content="/doks.png"><meta property="article:published_time" content="2020-10-06T08:49:31+00:00"><meta property="article:modified_time" content="2020-10-06T08:49:31+00:00"><meta property="og:site_name" content="Kerberos Docs"><meta property="article:publisher" content="https://www.facebook.com/"><meta property="article:author" content="https://www.facebook.com/"><meta property="og:locale" content="en_US"><script type=application/ld+json>{"@context":"http://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/doc.kerberos.io\/"},{"@type":"ListItem","position":3,"name":"Vault","item":"https:\/\/doc.kerberos.io\/\/vault\/"},{"@type":"ListItem","position":4,"name":"First Things First","item":"https:\/\/doc.kerberos.io\/\/vault\/first-things-first\/"}]}</script><meta name=theme-color content="#fff"><link rel=apple-touch-icon sizes=180x180 href=https://doc.kerberos.io/favicons/apple-touch-icon.png><link rel=icon type=image/png sizes=32x32 href=https://doc.kerberos.io/favicons/favicon-32x32.png><link rel=icon type=image/png sizes=16x16 href=https://doc.kerberos.io/favicons/favicon-16x16.png><link rel=manifest href=https://doc.kerberos.io/site.webmanifest><script async defer data-domain=doc.kerberos.io src=https://plausible.kerberos.io/js/plausible.js></script></head><body class="vault single"><div class="header-bar fixed-top"></div><header class="navbar fixed-top navbar-expand-md navbar-light"><div class=container><input class="menu-btn order-0" type=checkbox id=menu-btn>
|
|
<label class="menu-icon d-md-none" for=menu-btn><span class=navicon></span></label><a class="navbar-brand order-1 order-md-0 me-auto" href=https://doc.kerberos.io/><img src=https://doc.kerberos.io/images/kerberos-logo.svg class=logo>
|
|
Kerberos Docs</a>
|
|
<button id=mode class="btn btn-link order-2 order-md-4" type=button aria-label="Toggle mode">
|
|
<span class=toggle-dark><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-moon"><path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"/></svg></span><span class=toggle-light><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-sun"><circle cx="12" cy="12" r="5"/><line x1="12" y1="1" x2="12" y2="3"/><line x1="12" y1="21" x2="12" y2="23"/><line x1="4.22" y1="4.22" x2="5.64" y2="5.64"/><line x1="18.36" y1="18.36" x2="19.78" y2="19.78"/><line x1="1" y1="12" x2="3" y2="12"/><line x1="21" y1="12" x2="23" y2="12"/><line x1="4.22" y1="19.78" x2="5.64" y2="18.36"/><line x1="18.36" y1="5.64" x2="19.78" y2="4.22"/></svg></span></button><div class="collapse navbar-collapse order-4 order-md-1"><ul class="navbar-nav main-nav me-auto order-5 order-md-2"><li class=nav-item><a class=nav-link href=https://kerberos.io>Homepage</a></li></ul><div class="break order-6 d-md-none"></div><form class="navbar-form flex-grow-1 order-7 order-md-3"><input id=userinput class="form-control is-search" type=search placeholder="Search docs..." aria-label="Search docs..." autocomplete=off><div id=suggestions class="shadow bg-white rounded"></div></form></div></div></header><div class="wrap container" role=document><div class=content><div class="row flex-xl-nowrap"><div class="col-lg-5 col-xl-4 docs-sidebar"><nav class=docs-links aria-label="Main navigation"><h3>Prologue</h3><ul class=list-unstyled><li><a class=docs-link href=https://doc.kerberos.io/>Introduction</a></li><li><a class=docs-link href=https://doc.kerberos.io/prologue/how/>How it works</a></li><li><a class=docs-link href=https://doc.kerberos.io/prologue/deployments/>Deployments</a></li><li><a class=docs-link href=https://doc.kerberos.io/prologue/glossary/>Glossary</a></li></ul><h3>Opensource v2</h3><ul class=list-unstyled><li><a class=docs-link href=https://doc.kerberos.io/opensource/first-things-first/>First things first</a></li><li><a class=docs-link href=https://doc.kerberos.io/opensource/get-started/>Get started</a></li><li><a class=docs-link href=https://doc.kerberos.io/opensource/installation/>Installation</a></li><li><a class=docs-link href=https://doc.kerberos.io/opensource/installation-advanced/>Advanced Installation</a></li><li><a class=docs-link href=https://doc.kerberos.io/opensource/releases/>Release notes</a></li><li><a class=docs-link href=https://doc.kerberos.io/opensource/license/>License</a></li><li><a class=docs-link href=https://doc.kerberos.io/opensource/upgrade/>Upgrade</a></li><li><a class=docs-link href=https://doc.kerberos.io/opensource/contribute/>Contribute</a></li><li><a class=docs-link href=https://doc.kerberos.io/opensource/machinery/>Machinery</a></li><li><a class=docs-link href=https://doc.kerberos.io/opensource/web/>Web</a></li></ul><h3>Opensource v3</h3><ul class=list-unstyled><li><a class=docs-link href=https://doc.kerberos.io/opensourcev3/announcement/>Announcement</a></li></ul><h3>Enterprise</h3><ul class=list-unstyled><li><a class=docs-link href=https://doc.kerberos.io/enterprise/first-things-first/>First things first</a></li><li><a class=docs-link href=https://doc.kerberos.io/enterprise/get-started/>Get Started</a></li><li><a class=docs-link href=https://doc.kerberos.io/enterprise/installation/>Installation</a></li><li><a class=docs-link href=https://doc.kerberos.io/enterprise/installation-cloud/>Cloud Installation</a></li><li><a class=docs-link href=https://doc.kerberos.io/enterprise/installation-edge/>Edge Installation</a></li><li><a class=docs-link href=https://doc.kerberos.io/enterprise/releases/>Releases</a></li></ul><h3>Vault</h3><ul class=list-unstyled><li><a class="docs-link active" href=https://doc.kerberos.io/vault/first-things-first/>First things first</a></li><li><a class=docs-link href=https://doc.kerberos.io/vault/get-started/>Get Started</a></li><li><a class=docs-link href=https://doc.kerberos.io/vault/installation/>Installation</a></li><li><a class=docs-link href=https://doc.kerberos.io/vault/installation-cloud/>Cloud Installation</a></li><li><a class=docs-link href=https://doc.kerberos.io/vault/installation-edge/>Edge Installation</a></li><li><a class=docs-link href=https://doc.kerberos.io/vault/providers/>Providers</a></li><li><a class=docs-link href=https://doc.kerberos.io/vault/recycle/>Recycle</a></li><li><a class=docs-link href=https://doc.kerberos.io/vault/releases/releases/>Releases</a></li></ul><h3>Hub</h3><ul class=list-unstyled><li><a class=docs-link href=https://doc.kerberos.io/hub/first-things-first/>First things first</a></li></ul></nav></div><nav class="docs-toc d-none d-xl-block col-xl-4" aria-label="Secondary navigation"><div class=page-links><h3>On this page</h3><nav id=TableOfContents><ul><li><ul><li></li></ul></li><li><a href=#kerberos-hub-1>Kerberos Hub</a></li><li><a href=#kerberos-vault-1>Kerberos Vault</a><ul><li><a href=#events>Events</a></li><li><a href=#on-demand-upload>On-demand upload</a></li><li><a href=#open-api>Open API</a></li></ul></li><li><a href=#licensing>Licensing</a></li></ul></nav></div></nav><main class="docs-content col-lg-11 col-xl-8"><h1>First things first</h1><p class=lead></p><p>Kerberos Opensource and Kerberos Enterprise both store recordings on the local disk. To centralise your data at a single place, additional solutions are available.</p><h4 id=kerberos-hub>Kerberos Hub<a href=#kerberos-hub class=anchor aria-hidden=true>#</a></h4><p>One or more Kerberos Enterprise agents, can store their data directly on <a href=https://doc.kerberos.io/hub/first-things-first>Kerberos Hub</a>, 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).</p><h4 id=kerberos-vault>Kerberos Vault<a href=#kerberos-vault class=anchor aria-hidden=true>#</a></h4><p>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 <a href=https://doc.kerberos.io/hub/first-things-first>Kerberos Hub</a> 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.</p><p>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.</p><h2 id=kerberos-hub-1>Kerberos Hub<a href=#kerberos-hub-1 class=anchor aria-hidden=true>#</a></h2><p>Within Kerberos Opensource and Kerberos Enterprise you can upload your recordings to our public <a href=https://doc.kerberos.io/hub/first-things-first>Kerberos Hub</a> 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 <a href=https://doc.kerberos.io/hub/first-things-first>can be found here</a>.</p><figure class=stretch><img src=arch-kerberos-hub.svg alt="Store your recordings in Kerberos Hub"><figcaption><p>Store your recordings in Kerberos Hub</p></figcaption></figure><h2 id=kerberos-vault-1>Kerberos Vault<a href=#kerberos-vault-1 class=anchor aria-hidden=true>#</a></h2><p>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:</p><ul><li><a href=https://cloud.google.com/storage>Google Cloud Platform Storage</a></li><li><a href=https://azure.microsoft.com/en-us/services/storage/>Microsoft Azure Storage</a></li><li><a href=https://aws.amazon.com/s3/>Amazon Web Services S3</a></li><li><a href=https://min.io/>Minio</a></li></ul><p>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.</p><figure class=stretch><img src=arch-kerberos-vault-providers.svg alt="Bring your own storage using Kerberos Vault"><figcaption><p>Bring your own storage using Kerberos Vault</p></figcaption></figure><p>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.</p><figure class=stretch><img src=arch-edge-kerberos-vault.svg alt="Store your recordings at the edge with Kerberos Vault"><figcaption><p>Store your recordings at the edge with Kerberos Vault</p></figcaption></figure><h3 id=events>Events<a href=#events class=anchor aria-hidden=true>#</a></h3><p>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.</p><ul><li><a href=https://kafka.apache.org/>Apache Kafka</a></li><li><a href=https://aws.amazon.com/sqs/>Amazon Web Services SQS</a></li></ul><p>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.</p><figure class=stretch><img src=arch-kerberos-vault-events.svg alt="Build integrations and create your own workflows using the event capability of Kerberos Vault."><figcaption><p>Build integrations and create your own workflows using the event capability of Kerberos Vault.</p></figcaption></figure><h3 id=on-demand-upload>On-demand upload<a href=#on-demand-upload class=anchor aria-hidden=true>#</a></h3><p>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.</p><figure class=stretch><img src=arch-sync-kerberos-vault.svg alt="Synchronise recordings between multiple Kerberos Vault"><figcaption><p>Synchronise recordings between multiple Kerberos Vault</p></figcaption></figure><p>A couple of usecases are the following ones:</p><ul><li><p>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.</p></li><li><p>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.</p></li></ul><h3 id=open-api>Open API<a href=#open-api class=anchor aria-hidden=true>#</a></h3><p>Both Kerberos Enterprise as Kerberos Vault ships with Swagger API’s, which can be used to communicate with the previously mentioned systems. Simply type <code>/swagger/index.html</code> after the <code>api</code> url, and you will see the Swagger UI popping up. No need to explain the different API’s, use the Swagger and see what is available. See something missing, let us know, and we add it ;).</p><figure class=stretch><img src=open-api.png alt="All capabilities of Kerberos Vault are documented through swagger API's."><figcaption><p>All capabilities of Kerberos Vault are documented through swagger API’s</p></figcaption></figure><h2 id=licensing>Licensing<a href=#licensing class=anchor aria-hidden=true>#</a></h2><p>Kerberos Vault is publicly available and <strong>requires a license key</strong> to operate correctly. Reach out to <strong>cedric@kerberos.io</strong> for the commercial matters.</p><p class=edit-page><a href=https://github.com/kerberos-io/documentation/blob/master/content/vault/first-things-first/index.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class="docs-navigation d-flex justify-content-between"><a class=ms-auto href=https://doc.kerberos.io/vault/get-started/><div class="card my-1"><div class="card-body py-2">Get Started →</div></div></a></div></main></div></div></div><footer class="footer text-muted"><div class=container><div class=row><div class="col-lg-6 order-last order-lg-first"><ul class="navbar-nav social-nav"><li class=copyright>© 2014–2021
|
|
<a href=https://kerberos.io>Kerberos.io</a></li><li class=nav-item><a class=link href=https://twitter.com/kerberosio title=Twitter><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 01-3.14 1.53 4.48 4.48.0 00-7.86 3v1A10.66 10.66.0 013 4s-4 9 5 13a11.64 11.64.0 01-7 2c9 5 20 0 20-11.5a4.5 4.5.0 00-.08-.83A7.72 7.72.0 0023 3z"/></svg><span class="ms-2 visually-hidden">Twitter</span></a></li><li class=nav-item><a class=link href=https://github.com/kerberos-io title=GitHub><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-github"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37.0 00-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44.0 0020 4.77 5.07 5.07.0 0019.91 1S18.73.65 16 2.48a13.38 13.38.0 00-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07.0 005 4.77 5.44 5.44.0 003.5 8.55c0 5.42 3.3 6.61 6.44 7A3.37 3.37.0 009 18.13V22"/></svg><span class="ms-2 visually-hidden">GitHub</span></a></li><li class=nav-item><a class=link href=https://www.reddit.com/r/kerberos_io/ title=Reddit><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-message-circle"><path d="M21 11.5a8.38 8.38.0 01-.9 3.8A8.5 8.5.0 0112.5 20a8.38 8.38.0 01-3.8-.9L3 21l1.9-5.7A8.38 8.38.0 014 11.5a8.5 8.5.0 014.7-7.6 8.38 8.38.0 013.8-.9h.5a8.48 8.48.0 018 8v.5z"/></svg><span class="ms-2 visually-hidden">Reddit</span></a></li></ul></div><div class="col-lg-10 order-first order-lg-last text-lg-end"><ul class=list-inline><li class=list-inline-item>Learn more about</li><li class=list-inline-item><a href=https://kerberos.io/product/enterprise-agent/>Enterprise Agent</a></li><li class=list-inline-item><a href=https://kerberos.io/product/hub/>Hub</a></li><li class=list-inline-item><a href=https://kerberos.io/product/open-source/>Kerberos Opensource</a></li><li class=list-inline-item><a href=https://kerberos.io/product/vault/>Vault</a></li></ul></div></div></div></footer><script src=https://doc.kerberos.io/js/highlight.min.13bf6b39f28cd07b0780c0c154bf050bad1e7b73231c15e43b993504cca3fa814222ded3c525f429528451fe039a5078c71ae4d000486d26f9b920cc7db474da.js integrity="sha512-E79rOfKM0HsHgMDBVL8FC60ee3MjHBXkO5k1BMyj+oFCIt7TxSX0KVKEUf4DmlB4xxrk0ABIbSb5uSDMfbR02g==" crossorigin=anonymous defer></script><script src=https://doc.kerberos.io/main.min.89223fc6eee34e2dc10266cff3c7fc87949c595388f775ec6e93132410cef77e5ff7f24a81db03c9b9eb6d2e6d75ea5a7d22945c574b65dfeb426f65af771230.js integrity="sha512-iSI/xu7jTi3BAmbP88f8h5ScWVOI93XsbpMTJBDO935f9/JKgdsDybnrbS5tdepafSKUXFdLZd/rQm9lr3cSMA==" crossorigin=anonymous defer></script><script src=https://doc.kerberos.io/index.min.71e05784bf5441c378e8824d18e4b5a057f28cde2bd06f927216eb278586f7ea7d96309df4600474b3b928ef2b635a64248e2cf3a7a023136087ed4050162608.js integrity="sha512-ceBXhL9UQcN46IJNGOS1oFfyjN4r0G+SchbrJ4WG9+p9ljCd9GAEdLO5KO8rY1pkJI4s86egIxNgh+1AUBYmCA==" crossorigin=anonymous defer></script></body></html> |