diff --git a/content/help/faq/index.md b/content/help/faq/index.md index dbdc457..e568712 100644 --- a/content/help/faq/index.md +++ b/content/help/faq/index.md @@ -4,7 +4,7 @@ description: "Answers to frequently asked questions." lead: "Answers to frequently asked questions." date: 2020-10-06T08:49:31+00:00 lastmod: 2020-10-06T08:49:31+00:00 -draft: false +draft: true images: [] menu: help: diff --git a/content/help/how-to-update/index.md b/content/help/how-to-update/index.md index d2c672b..05b7a55 100644 --- a/content/help/how-to-update/index.md +++ b/content/help/how-to-update/index.md @@ -4,7 +4,7 @@ description: "Regularly update the installed npm packages to keep your Doks webs lead: "Regularly update the installed npm packages to keep your Doks website stable, usable, and secure." date: 2020-11-12T13:26:54+01:00 lastmod: 2020-11-12T13:26:54+01:00 -draft: false +draft: true images: [] menu: help: diff --git a/content/help/troubleshooting/index.md b/content/help/troubleshooting/index.md index e0ed127..f96cf2d 100644 --- a/content/help/troubleshooting/index.md +++ b/content/help/troubleshooting/index.md @@ -4,7 +4,7 @@ description: "Solutions to common problems." lead: "Solutions to common problems." date: 2020-11-12T15:22:20+01:00 lastmod: 2020-11-12T15:22:20+01:00 -draft: false +draft: true images: [] menu: help: diff --git a/content/hub/first-things-first/accounts.png b/content/hub/first-things-first/accounts.png new file mode 100644 index 0000000..b451058 Binary files /dev/null and b/content/hub/first-things-first/accounts.png differ diff --git a/content/hub/first-things-first/alerts.png b/content/hub/first-things-first/alerts.png new file mode 100644 index 0000000..baa98b0 Binary files /dev/null and b/content/hub/first-things-first/alerts.png differ diff --git a/content/hub/first-things-first/architecture.svg b/content/hub/first-things-first/architecture.svg new file mode 100644 index 0000000..7a8b9c9 --- /dev/null +++ b/content/hub/first-things-first/architecture.svg @@ -0,0 +1,759 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/content/hub/first-things-first/channels.png b/content/hub/first-things-first/channels.png new file mode 100644 index 0000000..8f07d4a Binary files /dev/null and b/content/hub/first-things-first/channels.png differ diff --git a/static/images/storage/kerberos-storage-events.svg b/content/hub/first-things-first/deployment-hub-vault.svg similarity index 85% rename from static/images/storage/kerberos-storage-events.svg rename to content/hub/first-things-first/deployment-hub-vault.svg index e808bde..a80e6c8 100644 --- a/static/images/storage/kerberos-storage-events.svg +++ b/content/hub/first-things-first/deployment-hub-vault.svg @@ -1,5 +1,4 @@ - @@ -10,34 +9,34 @@ - + - + - + - - + + - + - - - + + + - + @@ -45,58 +44,56 @@ - - + + - - - + + + - + - - + + - + - - + + - + - - + + - + - + - + - - @@ -107,34 +104,34 @@ - + - + - + - - + + - + - - - + + + - + @@ -142,58 +139,56 @@ - - + + - - - + + + - + - - + + - + - - + + - + - - + + - + - + - + - - @@ -204,34 +199,34 @@ - + - + - + - - + + - + - - - + + + - + @@ -239,57 +234,56 @@ - - + + - - - + + + - + - - + + - + - - + + - + - - + + - + - + - + - @@ -298,14 +292,13 @@ - + - - - - - - + + + + + @@ -314,40 +307,31 @@ - - - + - - - + - - - + - + - - - - + @@ -358,13 +342,13 @@ - + - + @@ -381,7 +365,7 @@ - + @@ -527,7 +511,7 @@ - + @@ -535,7 +519,7 @@ - + @@ -547,7 +531,7 @@ - + @@ -555,7 +539,7 @@ - + @@ -567,7 +551,7 @@ - + @@ -575,7 +559,7 @@ - + @@ -587,7 +571,7 @@ - + @@ -595,7 +579,7 @@ - + @@ -607,7 +591,7 @@ - + @@ -615,7 +599,7 @@ - + @@ -627,7 +611,7 @@ - + @@ -635,7 +619,7 @@ - + diff --git a/content/hub/first-things-first/index.md b/content/hub/first-things-first/index.md index 7b4d202..8a14e2b 100644 --- a/content/hub/first-things-first/index.md +++ b/content/hub/first-things-first/index.md @@ -12,3 +12,143 @@ menu: weight: 300 toc: true --- + +When installing a Kerberos agent inside your local network, it's possible to review your activity by using the agent's web interface. By nature, you will not be able to access the web interface from the cloud (outside your local network). On top of that, the Kerberos agent doesn't come with a consolidated overview. This means that you will need to open multiple web interfaces, one for each connected surveillance camera. + +To simplify and resolve all of these challenges, Kerberos Hub was developed. + +> [Kerberos Hub](https://app.kerberos.io) is a cloud solution which allows you to have a single overview of all the media recordings generated by your surveillance cameras. It's not a solution for processing your surveillance cameras in the cloud. For processing of your surveillance cameras, a Kerberos agent is used. + +A brief list of the key features of Kerberos Hub are: + +- Secured storage +- Consolidated overview +- Advanced searching +- Machine learning +- Alerts +- Live streaming +- Accounts +- Logging + +> Checkout [the demo environment](https://app-demo.kerberos.io) to see and feel the Kerberos Hub solution yourself. + +## Architecture + +A simplified architecture is found below. In this architecture the Kerberos agents are installed on-premise, next to the surveillance cameras. Once one of the agents recorded something it will send the recording to our [Kerberos Vault](/vault/first-things-first), using the credentials you've defined inside the agent. + +As soon as the recording is succesfully received several engines will be executed, that will further process the recording and extract metadata from it (classification, origin of the surveillance camera, etc). A lot of processing is happening behind the scenes (by what we call microservices). + +By using a browser you can navigate to Kerberos Hub, and review all the recordings made by the Kerberos agents. On top of that you will receive more context about the recordings, get notifications, view a livestream and much more. + +{{< figure src="architecture.svg" alt="Kerberos Hub is composed out of of different microservices." caption="Kerberos Hub is composed out of of different microservices." class="stretch">}} + +### Public or Private edition + +They are two different versions of using and deploying Kerberos Hub, we have the public and private dition. What's the difference? + +The Public edition of Kerberos Hub, is running all its services in what we often call the public cloud; and to be more specific on AWS and GCP. The Public cloud is mainly built for people who want to have a low cost and small scale VMS in the cloud. It's easy to (un)subscribe to the system, and you can connect your Kerberos agents in a matter of seconds. + +On the other hand we also have the private edition, which is available for enterprises. In contrary to the public edition, a customer can deploy the entire Kerberos Hub platform (with all its microservices) where it wants (on-premise or cloud). Both public and private edition are built on Kubernetes, this means that you will need to +have a Kubernetes cluster available at the location you which to install Kerberos Hub. + +For more information about the licensing of Kerberos Hub private edition, please get in touch with cedric@verstraeten.io. The licensing model of Kerberos Hub public edition can be found online. + +## Features + +So you might wonder, what's actually inside the platform? Please find a concrete list of functionalities below, this should give you more insights about how it looks like and what the capabilities are. + +## Secured storage + +Kerberos Hub allows you to store your data in the cloud, and make it available using a secured web interface. This is how it works. + +Once you've installed a Kerberos agent, and created an account on [Kerberos Hub](https://cloud.kerberos.io), you will be able to connect both systems together. By entering credentials received from Kerberos Hub, into your Kerberos agent, your media recordings will be send to our cloud storage. + +> You can link one or more Kerberos agents to your Kerberos Hub account. + +After linking your media recorded by a Kerberos agent will be send to our secure cloud storage, Kerberos Vault. By default our own [Kerberos Vault](/storage/introduction) service is used, however you can install your own [Kerberos Vault](/storage/introduction) and link it to our public cloud. By doing this all the recordings are stored in your own datacenter of choice, and only metadata is stored inside Kerberos Hub. + +{{< figure src="deployment-hub-vault.svg" alt="You connect your agents to Kerberos Hub, through Kerberos Vault." caption="You connect your agents to Kerberos Hub, through Kerberos Vault." class="stretch">}} + +Once stored your media recordings will be processed by different functions and algorithms to send alerts, apply machine learning and much more. + +> Kerberos Hub is much more than a storage service, you get intelligent capabilities as well. Read on to discover more. + +## Consolidated overview + +Kerberos Hub will group your media recordings (coming from one or more Kerberos agents) into time bundles. We do this to simplify the searching of a specific event. Less data is shown at once, and when needed you can drill down a level deeper to see more details. + +{{< figure src="overview.png" alt="The media page gives you an overview of all your recordings." caption="The media page gives you an overview of all your recordings." class="stretch">}} + +In a sneak peek you will see how many media recordings were generated during a certain time period, and which Kerberos agents were involved. For example, this might give you an indication of a particular event (more about in the machine learning section). + +### Security + +Once you're inside your Kerberos Hub account, you will see all the available media recordings of your Kerberos agents in a single interface. So how does this work? + +When you open Kerberos Hub we will generate temporary and private links for every media recording within your account. This link includes a random and unique hash, and is only available for a couple of minutes. So this means that your recording cannot be shared afterwards, or the risk someone else accessing that link is minimised. + +## Advanced searching + +Next to showing all your recordings in one overview, we also give you the capabilities to search for a recording more easily. For example you can search for recordings within a specific time boundary, recordings generated by a specific Kerberos agent, recordings which are marked as important, classified recordings such as pedestrians or animals, and more. + +{{< figure src="search.png" alt="Detailed searching across different sites and cameras. Using smart search to look for specific objects." caption="Detailed searching across different sites and cameras. Using smart search to look for specific objects." class="stretch">}} + +## Machine learning + +With Kerberos Hub you will get far more than just a nice interface for finding back your recordings. When a recording is uploaded to Kerberos Hub, we will execute all kind of algorithms. One of these algorithms is classification. This algorithm is used to classify/recognise all the objects inside your recording. Any human, vehicle or animal in the recording will be labeled. + +Next to classifying, the algorithm is also tracing the classified objects. By doing this we can label the recording with the object of interest. For example at the image below you see the traject of a pedestrian walking by (710 pixels). + +{{< figure src="ml.png" alt="When running your recordings on our Kerberos Hub, it will be processed by our ML service." caption="When running your recordings on our Kerberos Hub, it will be processed by our ML service." class="stretch">}} + +###### {{< figure src="ml2.png" alt="You can filter and drill down into specific media where a classification was detected." caption="You can filter and drill down into specific media where a classification was detected." class="stretch">}} + +## Alerts + +When a specific event occurred, a notification can be send to one or more channels. A user can compose an event by selecting one or more conditions. Once the event is triggered, a notification is sent to all the enabled channels. + +### Alerts + +Kerberos Hub supports different types of alerts: + +- **Detections**: send a notification if a recording was received from a specific Kerberos agent, within a time range, with a specific classification, etc. +- **Devices**: when one of your Kerberos agents stopped working, a notification can be send. +- **High upload**: when a lot of recordings are generated within a specific period of time, a notification can be send. + +{{< figure src="alerts.png" alt="Configure specific scenarios to trigger alerts." caption="Configure specific scenarios to trigger alerts." class="stretch">}} + +### Channels + +Kerberos Hub supports different types of channels, towards notifications can be send: + +- **Browser**: notifications inside the browser (if the used browser supports this). +- **E-mail**: a personal email can be send. +- **Slack**: send a message to a slack channel. +- **Alexa**: send a notification to Alexa skill ([Notify Me](https://www.amazon.com/Thomptronics-Notify-Me/dp/B07BB2FYFS)). +- **Telegram**: send a message to a Telegram channel. +- **Pushbullet**: send a message to a Pushbullet channel. +- **Pushover**: send a message to a Pushover channel. +- **Webhook**: trigger a webhook (POST). +- **IFTTT**: send a message to IFTTT. +- **SMS**: send a text message to a mobile number. + +{{< figure src="channels.png" alt="Channels allow you to communicate to external services." caption="Channels allow you to communicate to external services." class="stretch">}} + +## Livestreaming + +Kerberos Hub allows you to live stream from your Kerberos agents to your Kerberos Hub account. + +For Kerberos Open Source a low resolution livestream is made available, this will allow you to see what is happening in front of your surveillance camera in real-time. The stream is shared over MQTT (TCPS) and visualised in the Kerberos Hub webinterface using secure websockets (WSS). No port forwarding needs to be enabled. + +{{< figure src="livestream.png" alt="A Kerberos agent will give you access to the livestream, and a HD stream when using the enterprise agent." caption="A Kerberos agent will give you access to the livestream, and a HD stream when using the enterprise agent." class="stretch">}} + +For Kerberos Enterprise a HD livestream is made available. The full resolution and FPS is send through a concept called WebRTC. This WebRTC technology, is used my all major conferencing tools such as Zoom, Teams, etc. + +## Accounts + +It's possible to create multiple accounts (also called subaccounts) within your main account. Their are two different roles: + +- Guest: will only see your media recordings. A guest cannot modify, delete or create something. +- Editor: has full access, same permissions as the main account. + +{{< figure src="accounts.png" alt="Using accounts you can give external people access." caption="Using accounts you can give external people access." class="stretch">}} diff --git a/content/hub/first-things-first/livestream.png b/content/hub/first-things-first/livestream.png new file mode 100644 index 0000000..777e518 Binary files /dev/null and b/content/hub/first-things-first/livestream.png differ diff --git a/content/hub/first-things-first/ml.png b/content/hub/first-things-first/ml.png new file mode 100644 index 0000000..c600862 Binary files /dev/null and b/content/hub/first-things-first/ml.png differ diff --git a/content/hub/first-things-first/ml2.png b/content/hub/first-things-first/ml2.png new file mode 100644 index 0000000..83fc153 Binary files /dev/null and b/content/hub/first-things-first/ml2.png differ diff --git a/content/hub/first-things-first/overview.png b/content/hub/first-things-first/overview.png new file mode 100644 index 0000000..ab5311a Binary files /dev/null and b/content/hub/first-things-first/overview.png differ diff --git a/content/hub/first-things-first/search.png b/content/hub/first-things-first/search.png new file mode 100644 index 0000000..294c12d Binary files /dev/null and b/content/hub/first-things-first/search.png differ diff --git a/content/hub/get-started/index.md b/content/hub/get-started/index.md index bbf1f2d..1d26815 100644 --- a/content/hub/get-started/index.md +++ b/content/hub/get-started/index.md @@ -4,7 +4,7 @@ description: "" lead: "" date: 2020-10-06T08:49:31+00:00 lastmod: 2020-10-06T08:49:31+00:00 -draft: false +draft: true images: [] menu: hub: diff --git a/content/hub/installation/index.md b/content/hub/installation/index.md index e5847bd..039b8b4 100644 --- a/content/hub/installation/index.md +++ b/content/hub/installation/index.md @@ -4,7 +4,7 @@ description: "" lead: "" date: 2020-10-06T08:49:31+00:00 lastmod: 2020-10-06T08:49:31+00:00 -draft: false +draft: true images: [] menu: hub: diff --git a/content/hub/releases/index.md b/content/hub/releases/index.md index 0f48def..1f6b283 100644 --- a/content/hub/releases/index.md +++ b/content/hub/releases/index.md @@ -4,7 +4,7 @@ description: "" lead: "" date: 2020-10-06T08:49:31+00:00 lastmod: 2020-10-06T08:49:31+00:00 -draft: false +draft: true images: [] menu: hub: diff --git a/content/vault/first-things-first/arch-edge-kerberos-vault.svg b/content/vault/first-things-first/arch-edge-kerberos-vault.svg index 0c391a5..e12c88c 100644 --- a/content/vault/first-things-first/arch-edge-kerberos-vault.svg +++ b/content/vault/first-things-first/arch-edge-kerberos-vault.svg @@ -66,13 +66,13 @@ - + - + - + @@ -90,10 +90,10 @@ - + - - + + @@ -161,13 +161,13 @@ - + - + - + @@ -185,10 +185,10 @@ - + - - + + @@ -256,13 +256,13 @@ - + - + - + @@ -280,10 +280,10 @@ - + - - + + @@ -291,7 +291,385 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -300,40 +678,40 @@ - + - + - + - + - + - + - + - + - + - - - + + + @@ -350,7 +728,7 @@ - + @@ -364,7 +742,7 @@ - + @@ -378,7 +756,7 @@ - + @@ -392,7 +770,7 @@ - + @@ -406,7 +784,7 @@ - + @@ -420,7 +798,7 @@ - + @@ -434,7 +812,63 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -454,6 +888,125 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -574,6 +1127,126 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/static/images/storage/account.gif b/content/vault/get-started/account.gif similarity index 100% rename from static/images/storage/account.gif rename to content/vault/get-started/account.gif diff --git a/content/vault/get-started/index.md b/content/vault/get-started/index.md index e8eb9ac..8c1562f 100644 --- a/content/vault/get-started/index.md +++ b/content/vault/get-started/index.md @@ -29,7 +29,7 @@ A [concrete tutorial can be found here](https://github.com/kerberos-io/storage/t Once you open a browser, and navigate to the Kerberos Storage web app (see installation for the URL), you will land on the login page. -![Storage - Login](../../public/images/storage/login.gif) +{{< figure src="login.gif" alt="After successful installation you should be able to access the login page." caption="After successful installation you should be able to access the login page." class="stretch">}} The default username and password of the Kerberos Storage app is: @@ -51,7 +51,7 @@ bnkBDAABB0V4cFRpbWUBBAAAABb/ghMBCmtlcmJlcm9zaW8B/MC7ZzIAAf+AOaJ+ Rta3+8zId+xtYQApdmHwo/Ih/vCN579iDeunwVQA -----END LICENSE KEY----- -![Storage - License Key](../../public/images/storage/licensekey.gif) +{{< figure src="licensekey.gif" alt="Before you can access the Kerberos Vault system, you will need a license key." caption="Before you can access the Kerberos Vault system, you will need a license key." class="stretch">}} Once you received a license key, and entered it into the web app you will be redirected to the login screen. Enter your credentials again, and you will land on the providers page (read more about it in the next chapter). @@ -67,9 +67,9 @@ Providers are the actual datasource where you want to store your recordings. The As explained before, for each provider, the appropriate security settings has to be filled in. For example for AWS you need to define the access and secret key, for GCP you need to define a service account. -Additionaly a provider can be marked as temporary. This is helpful if you wish to store your recordings for a short period, and want to use it for processing purpose only. A benefit of doing this is reducing costs (if you host in the public cloud). +A provider can be marked as temporary. This is helpful if you wish to store your recordings for a short period, and want to use it for processing purpose only. A benefit of doing this is reducing costs (if you host in the public cloud). -![Storage - Provider](../../public/images/storage/provider.gif) +{{< figure src="provider.gif" alt="One or more providers can be configured to centralise your storage." caption="One or more providers can be configured to centralise your storage." class="stretch">}} ## Queues @@ -83,7 +83,7 @@ An example or usecase of Queues is already discussed at the beginning of this pa - Counting algorithms, - and much more. -![Storage - Queue](../../public/images/storage/queue.gif) +{{< figure src="queue.gif" alt="Kerberos Vault can be configured to send events to message brokers to create real-time apps of ML models." caption="Kerberos Vault can be configured to send events to message brokers to create real-time apps of ML models." class="stretch">}} ## Accounts @@ -101,13 +101,13 @@ As explained before, you can choose in which directory, the `Provider directory` Once an account is created it can be used in Kerberos Enterprise (and soon Kerberos Open Source) to persist your data from your Kerberos Enterprise agent into your own `Provider`. -![Storage - Account](../../public/images/storage/account.gif) +{{< figure src="account.gif" alt="One or more accounts can be created to secure your storage access." caption="One or more accounts can be created to secure your storage access." class="stretch">}} ## Media Once a recording is stored inside a specific `Provider` it will show up on the `Media` page. The `Media` page is an overview, list page, of all your recordings being uploaded to a `Provider`. It is used for quickly reviewing activity as for recycling, for the latter read more at the next paragraph. -![Storage](../../public/images/kerberos-storage-media.png) +{{< figure src="media.png" alt="All uploaded recordings are visualised through the media page." caption="All uploaded recordings are visualised through the media page." class="stretch">}} ## Recycle diff --git a/static/images/storage/licensekey.gif b/content/vault/get-started/licensekey.gif similarity index 100% rename from static/images/storage/licensekey.gif rename to content/vault/get-started/licensekey.gif diff --git a/static/images/storage/login.gif b/content/vault/get-started/login.gif similarity index 100% rename from static/images/storage/login.gif rename to content/vault/get-started/login.gif diff --git a/content/vault/get-started/media.png b/content/vault/get-started/media.png new file mode 100644 index 0000000..c21ccbe Binary files /dev/null and b/content/vault/get-started/media.png differ diff --git a/static/images/storage/provider.gif b/content/vault/get-started/provider.gif similarity index 100% rename from static/images/storage/provider.gif rename to content/vault/get-started/provider.gif diff --git a/static/images/storage/queue.gif b/content/vault/get-started/queue.gif similarity index 100% rename from static/images/storage/queue.gif rename to content/vault/get-started/queue.gif diff --git a/static/images/storage/kerberos-storage-swagger.png b/content/vault/get-started/swagger.png similarity index 100% rename from static/images/storage/kerberos-storage-swagger.png rename to content/vault/get-started/swagger.png diff --git a/content/vault/installation-cloud/index.md b/content/vault/installation-cloud/index.md index d19ee85..6c66852 100644 --- a/content/vault/installation-cloud/index.md +++ b/content/vault/installation-cloud/index.md @@ -21,17 +21,17 @@ If not already the case, start by installing a Kubernetes cluster. This can be d ## Prerequisites -Kerberos Storage is the storage component for Kerberos Enterprise. It is used to store your recordings at a central place, in the storage system you prefer. Next to that it can be used for extension and integration capabilities. Learn more about [Kerberos Storage here](/storage). +Kerberos Vault is the storage component for Kerberos Enterprise. It is used to store your recordings at a central place, in the storage system you prefer. Next to that it can be used for extension and integration capabilities. Learn more about [Kerberos Vault here](/storage). -To use Kerberos Storage, you will need to have Kerberos Enterprise installed, and deployments running. Independent from that one can also use the Kerberos Storage API `/swagger/index.html` to send recordings from a custom build VMS. +To use Kerberos Vault, you will need to have Kerberos Enterprise installed, and deployments running. Independent from that one can also use the Kerberos Vault API `/swagger/index.html` to send recordings from a custom build VMS. ## Installation -Similar to Kerberos Enterprise, Kerberos Storage, requires some initial components to be installed. If you will run Kerberos Storage in the same cluster as where you have Kerberos Enterprise running, there is not much to do. +Similar to Kerberos Enterprise, Kerberos Vault, requires some initial components to be installed. If you will run Kerberos Vault in the same cluster as where you have Kerberos Enterprise running, there is not much to do. -![architecture kubernetes](../../public/images/kerberos-storage-architecture-kubernetes-cloud.png) +{{< figure src="../first-things-first/arch-kerberos-vault-providers.svg" alt="Bring your own storage using Kerberos Vault" caption="Bring your own storage using Kerberos Vault" class="stretch">}} -However if you plan to run Kerberos Storage in a different cluster (which is perfectly possible), you will need to make sure you complete the initial setup of [Kerberos Enterprise installation](/enterprise/installation). To be more specific you will need the following components running: +However if you plan to run Kerberos Vault in a different cluster (which is perfectly possible), you will need to make sure you complete the initial setup of [Kerberos Enterprise installation](/enterprise/installation). To be more specific you will need the following components running: - Helm - MongoDB @@ -43,9 +43,9 @@ Once this is done start by cloning the configurations from our [Github repo](htt ### Storage -Similar to Kerberos Enterprise, Kerberos Storage is managed through a web app. It allows you to add storage providers (S3, minio, etc), add queues for messaging, accounts for security and much more. It also comes with API's, which you can use to interact and retrieve information from Kerberos Storage. All is documented in the form of Swagger APIs `/swagger/index.html`. +Similar to Kerberos Enterprise, Kerberos Vault is managed through a web app. It allows you to add storage providers (S3, minio, etc), add queues for messaging, accounts for security and much more. It also comes with API's, which you can use to interact and retrieve information from Kerberos Vault. All is documented in the form of Swagger APIs `/swagger/index.html`. -Before installing Kerberos Storage, open the `./storage/yaml/deployment.yaml` configuration file. At the bottom file you will find two endpoints, similar to the Traefik config file below. Update the domain names to your own domain, and add these to your DNS server or `/etc/hosts` file (and point to the same IP as the Traefik EXTERNAL-IP). +Before installing Kerberos Vault, open the `./storage/yaml/deployment.yaml` configuration file. At the bottom file you will find two endpoints, similar to the Traefik config file below. Update the domain names to your own domain, and add these to your DNS server or `/etc/hosts` file (and point to the same IP as the Traefik EXTERNAL-IP). spec: rules: @@ -82,7 +82,7 @@ Next to that modify the MongoDB credentials, and make sure they match the creden - name: MONGODB_PASSWORD --> value: "xxxxxxxxxx" -Once you have corrected the DNS names and MongoDB credentials, install Kerberos Storage inside your cluster. +Once you have corrected the DNS names and MongoDB credentials, install Kerberos Vault inside your cluster. kubectl apply -f ./storage/yaml/deployment.yaml @@ -107,4 +107,4 @@ It should look like this. Once everything is configured correctly your cluster and DNS or `/etc/hosts` file, you should be able to access the Storage application. By navigating to the Storage domain `storage.domain.com` in your browser you will see the Storage login page showing up. -![Storage](../../public/images/factory/kerberos-factory-loginpage.png) \ No newline at end of file +{{< figure src="login.png" alt="Once successfully installed Kerberos Vault, it will show you the login page." caption="Once successfully installed Kerberos Vault, it will show you the login page." class="stretch">}} \ No newline at end of file diff --git a/content/vault/installation-cloud/login.png b/content/vault/installation-cloud/login.png new file mode 100644 index 0000000..0c2a41e Binary files /dev/null and b/content/vault/installation-cloud/login.png differ diff --git a/content/vault/installation-edge/index.md b/content/vault/installation-edge/index.md index a7a07e2..009f151 100644 --- a/content/vault/installation-edge/index.md +++ b/content/vault/installation-edge/index.md @@ -13,23 +13,22 @@ weight: 304 toc: true --- -Welcome to the Kerberos Storage Edge installation. This is the way to go if you want to install Kerberos Storage on your Baremetal infrastructure or inside your Private Cloud. - -![architecture kubernetes](../../public/images/kerberos-storage-architecture-kubernetes-edge.png) +Welcome to the Kerberos Vault Edge installation. This is the way to go if you want to install Kerberos Vault on your Baremetal infrastructure or inside your Private Cloud. +{{< figure src="../first-things-first/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">}} Before we can actual start installing the different deployments in our cluster, we need to make sure we have one available. ## Prerequisites -Kerberos Storage is the storage component for Kerberos Enterprise. It is used to store your recordings at a central place, in the storage system you prefer. Next to that it can be used for extension and integration capabilities. Learn more about [Kerberos Storage here](/storage). +Kerberos Vault is the storage component for Kerberos Enterprise. It is used to store your recordings at a central place, in the storage system you prefer. Next to that it can be used for extension and integration capabilities. Learn more about [Kerberos Vault here](/storage). -To use Kerberos Storage, you will need to have Kerberos Enterprise installed, and deployments running. Independent from that one can also use the Kerberos Storage API `/swagger/index.html` to send recordings from a custom build VMS. +To use Kerberos Vault, you will need to have Kerberos Enterprise installed, and deployments running. Independent from that one can also use the Kerberos Vault API `/swagger/index.html` to send recordings from a custom build VMS. ## Installation -Similar to Kerberos Enterprise, Kerberos Storage, requires some initial components to be installed. If you will run Kerberos Storage in the same cluster as where you have Kerberos Enterprise running, there is not much to do. +Similar to Kerberos Enterprise, Kerberos Vault, requires some initial components to be installed. If you will run Kerberos Vault in the same cluster as where you have Kerberos Enterprise running, there is not much to do. -However if you plan to run Kerberos Storage in a different cluster (which is perfectly possible), you will need to make sure you complete the initial setup of [Kerberos Enterprise Edge](/enterprise/installation-edge) installation. To be more specific you will need the following components running: +However if you plan to run Kerberos Vault in a different cluster (which is perfectly possible), you will need to make sure you complete the initial setup of [Kerberos Enterprise Edge](/enterprise/installation-edge) installation. To be more specific you will need the following components running: - Helm - Calico @@ -43,9 +42,9 @@ Once this is done start by cloning the configurations from our [Github repo](htt ### Storage -Similar to Kerberos Enterprise, Kerberos Storage is managed through a web app. It allows you to add storage providers (S3, minio, etc), add queues for messaging, accounts for security and much more. It also comes with API's, which you can use to interact and retrieve information from Kerberos Storage. All is documented in the form of Swagger APIs `/swagger/index.html`. +Similar to Kerberos Enterprise, Kerberos Vault is managed through a web app. It allows you to add storage providers (S3, minio, etc), add queues for messaging, accounts for security and much more. It also comes with API's, which you can use to interact and retrieve information from Kerberos Vault. All is documented in the form of Swagger APIs `/swagger/index.html`. -Before installing Kerberos Storage, open the `./storage/yaml/deployment.yaml` configuration file. At the bottom file you will find two endpoints, similar to the Traefik config file below. Update the domain names to your own domain, and add these to your DNS server or `/etc/hosts` file (and point to the same IP as the Traefik EXTERNAL-IP). +Before installing Kerberos Vault, open the `./storage/yaml/deployment.yaml` configuration file. At the bottom file you will find two endpoints, similar to the Traefik config file below. Update the domain names to your own domain, and add these to your DNS server or `/etc/hosts` file (and point to the same IP as the Traefik EXTERNAL-IP). spec: rules: @@ -71,7 +70,7 @@ Next to that modify the MongoDB credentials, and make sure they match the creden - name: MONGODB_PASSWORD --> value: "xxxxxxxxxx" -Once you have corrected the DNS names and MongoDB credentials, install Kerberos Storage inside your cluster. +Once you have corrected the DNS names and MongoDB credentials, install Kerberos Vault inside your cluster. kubectl apply -f ./storage/yaml/deployment.yaml @@ -96,4 +95,4 @@ It should look like this. Once everything is configured correctly your cluster and DNS or `/etc/hosts` file, you should be able to access the Storage application. By navigating to the Storage domain `storage.domain.com` in your browser you will see the Storage login page showing up. -![Storage](../../public/images/factory/kerberos-factory-loginpage.png) \ No newline at end of file +{{< figure src="login.png" alt="Once successfully installed Kerberos Vault, it will show you the login page." caption="Once successfully installed Kerberos Vault, it will show you the login page." class="stretch">}} \ No newline at end of file diff --git a/content/vault/installation-edge/login.png b/content/vault/installation-edge/login.png new file mode 100644 index 0000000..0c2a41e Binary files /dev/null and b/content/vault/installation-edge/login.png differ diff --git a/content/vault/installation/deployment-models.svg b/content/vault/installation/deployment-models.svg new file mode 100644 index 0000000..e13e2f1 --- /dev/null +++ b/content/vault/installation/deployment-models.svg @@ -0,0 +1,415 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/content/vault/installation/deployments-models.svg b/content/vault/installation/deployments-models.svg new file mode 100644 index 0000000..9c4129a --- /dev/null +++ b/content/vault/installation/deployments-models.svg @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/content/vault/installation/index.md b/content/vault/installation/index.md index 0ea726d..d630cd3 100644 --- a/content/vault/installation/index.md +++ b/content/vault/installation/index.md @@ -13,39 +13,28 @@ weight: 302 toc: true --- -Kerberos Open Source (v3) is the next generation of Kerberos.io, and is the successor of (v1/v2). More specifically it will replace and merge the [machinery](https://github.com/kerberos-io/machinery) and [web](https://github.com/kerberos-io/web) repositories. A switch in technologies and architecture has been made. Version 3 is still under active development, and not yet released. The progress can be followed at the [develop branch](https://github.com/kerberos-io/opensource/tree/develop) and [project overview](https://github.com/kerberos-io/opensource/projects/1). +Just like Kerberos Enterprise, Kerberos Vault can be installed where Kubernetes can be installed. This means that it can run at the Edge - Baremetal -, in the cloud - VMs - or at Kubernetes service providers - SAAS - such as GCP, Azure, AWS, DigitalOcean, and the list goes on. -## What is changing? +Although you might except Kubernetes at the Edge or Kubernetes in the cloud, there are no differences, well sorry to say there are. As Kubernetes service providers implemented features such as LoadBalancers, Persistent Volumes, and others, they have automated and integrated a huge portion of the Kubernetes stack with their related PAAS services. To be more concrete if you are running a Kubernetes Cluster on GCP, you will use the LoadBalancing and Storage services from GCP. -At the bottom line, we are rebuilding the project from scratch using a different technology stack. We are saying goodbye to C++, PHP (Laravel), BackboneJS and saying hello to Golang and React. Despite the technology changes, we are also changing the architecture, we have put in place a couple of years ago. The biggest change is to run the show inside a single repository, and no longer over seperate repos (machinery and web). Read more about this in the FAQ. +{{< figure src="deployment-models.svg" alt="Kerberos Vault can be installed everywhere your Kubernetes cluster can be installed." caption="Kerberos Vault can be installed everywhere your Kubernetes cluster can be installed." class="stretch">}} -![Kerberos Open Source v2 - vs - v3](../public/images/kerberos-agent-v2-v3.png) +Compared to Kubernetes at the Edge, there are no predefined LoadBalancers, Storage capabilities, and more. This means more administration work for you, but - with great power comes great responsibility - so no worries. In the end there are alternative functionalties available, for features which you find out-of-the-box at the Kubernetes service providers, you just have to spend more time on configuring and installing those services/pods/deployments yourself. -## FAQ +## Installation on a Kubernetes Service Provider -### 1. Why a mono repo? +Installing Kerberos Vault, just like Kerberos Enterprise, on a Kubernetes Service Provider (Azure, GCP, AWS) is straight forward, as you can create a Kubernetes cluster in a few clicks, get access to public Load Balancers, storage and more. Running Kerberos Vault in such a cluster is just a matter of copy-pasting some configuration (yaml) files, and executing some `kubectl apply` commands. -We have noticed in the past (v1 and v2) splitting the repositories (machinery and web), created a lot of confusion within our community. People didn't understand the different versions and so on. This caused a lack of collaboration, and made it impossible for some people to collaborate and contribute. +{{< figure src="../first-things-first/arch-kerberos-vault-providers.svg" alt="Bring your own storage using Kerberos Vault" caption="Bring your own storage using Kerberos Vault" class="stretch">}} -Having a mono repo, which is well organised, simplifies the entry point for new people who would like to use, understand and/or contribute to Kerberos Open Source. +Install Kerberos Vault on a Kubernetes Service Provider by [following this step-by-step installation guide](/storage/installation-cloud). -### 2. Why a change in technologies? +## Installation in Private cloud or Baremetal -In previous versions (v1 and v2) we used technologies like C++, PHP and BackboneJS. 7 years ago this was still acceptable, however time has changed and new technologies such as React and Golang became very popular. +No need to install Kerberos Vault on a Kubernetes Service Provider, you could install it on your own Kubernetes cluster in your private cloud, or even better inside your own premise. The closer you bring Kerberos Vault to your surveillance infrastructure, and Kerberos Enterprise, the more benefits you will experience (low latency, low bandwidth, etc). -Due to previous reason we have decided to rebuild the Kerberos Open Source technology from scratch, taking into account all the feedback we acquired over the years. Having these technologies available, we will enable more people to contribute and use our technology. +{{< figure src="../first-things-first/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">}} -### 3. What is the difference with Kerberos Enterprise? +In contradiction to the Kubernetes Service Provider, you will have some work todo. Setting up Kubernetes Cluster, play with MetalLB, Persistent Volumes and claims. Don't be scared, it's pretty straight forward as well. You can't simple expect a: click, click, 💥 approach. -We started the developments of Kerberos Enterprise a year ago (January, 2020), our focus here was scalability, and fast development and easy deployment. We noticed that with technologies such as Golang and React, we can still provide a highly performant video surveillance system. - -Kerberos Open Source will use the same technology stack, and some code pieces, of Kerberos Enterprise which we have already build. We have a very clear now, of how a well developed and documented video surveillance system needs to look like. - -### 4. When are we going to be able to install the first version? - -We plan to ship the **first version by the end of Q1**, afterwards we will add more and more features as usual. - - -### 5. Change in License - -Kerberos Open Source (v3) is now available under the MIT license. \ No newline at end of file +Install Kerberos Vault on a Private cloud or Baremetal by [following this step-by-step installation guide](/vault/installation-edge). diff --git a/content/vault/providers/index.md b/content/vault/providers/index.md index 29686a5..c84efd6 100644 --- a/content/vault/providers/index.md +++ b/content/vault/providers/index.md @@ -84,4 +84,4 @@ Adapt the hostname to your needs, and apply the `deployment.yaml` file when appr You should now see Minio being installed, and able to access it from your favourite web browser. You can use with the credentials you have defined in the `deployment.yaml file.` -![minio kubernetes](../../public/images/minio/webapp.png) \ No newline at end of file +{{< figure src="minio.png" alt="When installing at the edge, the preferred installation method is MinIO." caption="When installing at the edge, the preferred installation method is MinIO." class="stretch">}} \ No newline at end of file diff --git a/static/images/minio/webapp.png b/content/vault/providers/minio.png similarity index 100% rename from static/images/minio/webapp.png rename to content/vault/providers/minio.png diff --git a/static/images/storage/daylimit.gif b/content/vault/recycle/daylimit.gif similarity index 100% rename from static/images/storage/daylimit.gif rename to content/vault/recycle/daylimit.gif diff --git a/content/vault/recycle/index.md b/content/vault/recycle/index.md index 61d40e3..894d698 100644 --- a/content/vault/recycle/index.md +++ b/content/vault/recycle/index.md @@ -23,7 +23,7 @@ Different recycling rules can be configured in the Kerberos Storage app. Based o When creating an `Account` on the Kerberos Storage app, you have the option to specify the day limit for that account. This day limit tells the recycle service, if it is time or not to remove the recording. -![Storage - Day Limit](../../public/images/storage/daylimit.gif) +{{< figure src="daylimit.gif" alt="You can remove your recordings by specifying the day limit field." caption="You can remove your recordings by specifying the day limit field." class="stretch">}} ## Prerequisites diff --git a/static/images/factory/kerberos-enterprise-kubernetes.png b/static/images/factory/kerberos-enterprise-kubernetes.png deleted file mode 100644 index 3eb9db1..0000000 Binary files a/static/images/factory/kerberos-enterprise-kubernetes.png and /dev/null differ diff --git a/static/images/factory/kerberos-factory-add-bulk-deployment.png b/static/images/factory/kerberos-factory-add-bulk-deployment.png deleted file mode 100644 index a11a872..0000000 Binary files a/static/images/factory/kerberos-factory-add-bulk-deployment.png and /dev/null differ diff --git a/static/images/factory/kerberos-factory-add-single-deployment.png b/static/images/factory/kerberos-factory-add-single-deployment.png deleted file mode 100644 index 53ba0dc..0000000 Binary files a/static/images/factory/kerberos-factory-add-single-deployment.png and /dev/null differ diff --git a/static/images/factory/kerberos-factory-config-region.png b/static/images/factory/kerberos-factory-config-region.png deleted file mode 100644 index fca47ca..0000000 Binary files a/static/images/factory/kerberos-factory-config-region.png and /dev/null differ diff --git a/static/images/factory/kerberos-factory-dashboard.png b/static/images/factory/kerberos-factory-dashboard.png deleted file mode 100644 index 6ad0b64..0000000 Binary files a/static/images/factory/kerberos-factory-dashboard.png and /dev/null differ diff --git a/static/images/factory/kerberos-factory-licensekey.png b/static/images/factory/kerberos-factory-licensekey.png deleted file mode 100644 index 10fa743..0000000 Binary files a/static/images/factory/kerberos-factory-licensekey.png and /dev/null differ diff --git a/static/images/factory/kerberos-factory-loginpage-small.png b/static/images/factory/kerberos-factory-loginpage-small.png deleted file mode 100644 index 9c185e2..0000000 Binary files a/static/images/factory/kerberos-factory-loginpage-small.png and /dev/null differ diff --git a/static/images/storage/opensourceagent.gif b/static/images/storage/opensourceagent.gif deleted file mode 100644 index 9e2f190..0000000 Binary files a/static/images/storage/opensourceagent.gif and /dev/null differ