From 80ce2fc36e570180726110eb18e5ffe911c16021 Mon Sep 17 00:00:00 2001 From: Cedric Verstraeten Date: Wed, 3 May 2023 19:02:39 +0200 Subject: [PATCH] updates --- content/agent/announcement/index.md | 6 +- .../agent/encryption/encryption-agent-hub.svg | 136 ++++++++++++ .../encryption/encryption-agent-vault.svg | 113 ++++++++++ .../agent/encryption/encryption-vault-hub.svg | 132 ++++++++++++ content/agent/encryption/encryption.svg | 193 ++++++++++++++++++ content/agent/encryption/index.md | 30 +++ content/factory/getting-started/index.md | 11 +- 7 files changed, 612 insertions(+), 9 deletions(-) create mode 100644 content/agent/encryption/encryption-agent-hub.svg create mode 100644 content/agent/encryption/encryption-agent-vault.svg create mode 100644 content/agent/encryption/encryption-vault-hub.svg create mode 100644 content/agent/encryption/encryption.svg create mode 100644 content/agent/encryption/index.md diff --git a/content/agent/announcement/index.md b/content/agent/announcement/index.md index 0aa5110..9e4959e 100644 --- a/content/agent/announcement/index.md +++ b/content/agent/announcement/index.md @@ -7,9 +7,9 @@ lastmod: 2020-10-06T08:49:31+00:00 draft: false images: [] menu: - agent: - parent: "agent" -weight: 300 + agent: + parent: "agent" +weight: 200 toc: true --- diff --git a/content/agent/encryption/encryption-agent-hub.svg b/content/agent/encryption/encryption-agent-hub.svg new file mode 100644 index 0000000..861055c --- /dev/null +++ b/content/agent/encryption/encryption-agent-hub.svg @@ -0,0 +1,136 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/content/agent/encryption/encryption-agent-vault.svg b/content/agent/encryption/encryption-agent-vault.svg new file mode 100644 index 0000000..4ec3498 --- /dev/null +++ b/content/agent/encryption/encryption-agent-vault.svg @@ -0,0 +1,113 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/content/agent/encryption/encryption-vault-hub.svg b/content/agent/encryption/encryption-vault-hub.svg new file mode 100644 index 0000000..db4c019 --- /dev/null +++ b/content/agent/encryption/encryption-vault-hub.svg @@ -0,0 +1,132 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/content/agent/encryption/encryption.svg b/content/agent/encryption/encryption.svg new file mode 100644 index 0000000..d6367a9 --- /dev/null +++ b/content/agent/encryption/encryption.svg @@ -0,0 +1,193 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/content/agent/encryption/index.md b/content/agent/encryption/index.md new file mode 100644 index 0000000..5086e42 --- /dev/null +++ b/content/agent/encryption/index.md @@ -0,0 +1,30 @@ +--- +title: "Encryption" +description: "End-to-end encryption to keep your recordings secure." +lead: "End-to-end encryption to keep your recordings secure." +date: 2023-04-09T21:45:00+00:00 +lastmod: 2023-04-09T21:45:00+00:00 +draft: true +images: [] +menu: + agent: + parent: "agent" +weight: 204 +toc: true +--- + +Kerberos Agent main goal is to make recordings and store them somewhere so you can access them. Next to "just" storing them, storing them securely is even more important, due to these we have integrated different levels of security in the Kerberos.io stack. + +![Encryption diagram](./encryption.svg) + +## Encryption from Kerberos Agent to Kerberos Vault + +![Encryption Kerberos Agent to Kerberos Vault](./encryption-agent-vault.svg) + +## Decryption from Kerberos Vault to Kerberos Hub + +![Encryption Kerberos Vault to Kerberos Hub](./encryption-vault-hub.svg) + +## Encryption from Kerberos Agent to Kerberos Hub + +![Encryption Kerberos Agent to Kerberos Hub](./encryption-agent-hub.svg) diff --git a/content/factory/getting-started/index.md b/content/factory/getting-started/index.md index 7cc95e5..9be21c8 100644 --- a/content/factory/getting-started/index.md +++ b/content/factory/getting-started/index.md @@ -13,7 +13,6 @@ weight: 301 toc: true --- - Once you've installed Kerberos Factory, you will have the web application running inside your cluster. This web application allows you to administrate and automate the creation of your Kerberos Agents through the concept of [Kubernetes deployments](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) and pods. Important to note is that this web application is relying [on the official Golang Kubernetes API](https://github.com/kubernetes/client-go), so that means from an administration point of view, you could simply use the well known `kubectl` command instead. The web application adds some functionalities on top of the Kubernetes API, which are specific to a Kerberos Agent; for example region of interests, livestreaming settings, etc. @@ -35,7 +34,7 @@ The default username password, specified in the [`deployment.yaml`](https://gith On the overview page you will find an intuitive overview of the different pages and functionalities. As Kerberos Factory is running on top of a Kubernetes cluster, Kerberos Agents are deployed as Kubernetes deployments. -Kerberos Factory allows you to inspect and configure your Kerberos Agents, but also provide an overview of the Kubernetes nodes and pods. +Kerberos Factory allows you to inspect and configure your Kerberos Agents, but also provide an overview of the Kubernetes nodes and pods. {{< figure src="overview.gif" alt="Review your Docker or Kubernetes agents." caption="Review your Docker or Kubernetes agents." class="stretch">}} @@ -66,7 +65,7 @@ By specifying a name for your Kerberos Agent, and it's corresponding RTSP url, a #### Adding through ONVIF -Instead of creating a new Kerberos Agent through a RTSP stream, you can discover streams through ONVIF, and enable additional features through ONVIF such as PTZ. Enable the ONVIF toggle, and type in the IP address, ONVIF username and ONVIF password. Click the verify connection, and select an RTSP stream from the profile list. +Instead of creating a new Kerberos Agent through a RTSP stream, you can discover streams through ONVIF, and enable additional features through ONVIF such as PTZ. Enable the ONVIF toggle, and type in the IP address, ONVIF username and ONVIF password. Click the verify connection, and select an RTSP stream from the profile list. {{< figure src="add-through-onvif.gif" alt="Deploy a Kerberos Agent with ONVIF capabilities." caption="Deploy a Kerberos Agent with ONVIF capabilities." class="stretch">}} @@ -100,7 +99,7 @@ By specifying configurations at a higher level, any Kerberos Agents will inherit At Kerberos, we have agile development cycles, which means that new versions will be released every day, week or month. To make sure you can upgrade or downgrade these Kerberos 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 one of your Kerberos Agents. When pressing the reboot button, next to your deployment, Kubernetes will destroy the pod of your deployment, and schedule a new one. +At any moment you can reboot one of your Kerberos Agents. When pressing the reboot button, next to your deployment, Kubernetes will destroy the pod of your deployment, and schedule a new one. {{< figure src="upgrade-kerberos-agent.gif" alt="You can specify the configurations on a global level, so all agents will inherit from that." caption="You can specify the configurations on a global level, so all agents will inherit from that." class="stretch">}} @@ -127,7 +126,7 @@ On the other hand it's an open platform, as it allows you build extensions and i To connect one or more Kerberos Agents to your Kerberos Vault instance, you should open the configuration option and navigate to the `cloud` tab. After selected you need to fill-in the credentials from your Kerberos Vault account. To connect one or more Kerberos Agents to your Kerberos Vault instance, you should open the configuration option and navigate to the `cloud` tab. After selected you need to fill-in the credentials from your Kerberos Vault account. -- Kerberos Vault URI: this is the API endpoint of your Kerberos Vault instance. Usually this is in the following format: `http(s)://api.yourdomain.com`. Where `api.yourdomain.com` should match your Kerberos Vault API endpoint. If you are deploying Kerberos Vault at the edge, in the same cluster, you can use the internal DNS name, as following `http://kerberos-vault.kerberos-vault:8081`. +- Kerberos Vault URI: this is the API endpoint of your Kerberos Vault instance. Usually this is in the following format: `http(s)://yourdomain.com/api`. Where `yourdomain.com` should match your Kerberos Vault endpoint. If you are deploying Kerberos Vault at the edge, in the same cluster, you can use the internal DNS name, as following `http://vault.kerberos-vault/api`. Where `vault` is the `service name` and `kerberos-vault` is the `namespace`. - Provider: the name of the provider, which you created on the Kerberos Vault providers page, to which you want to send your recordings to. @@ -153,7 +152,7 @@ Select the Kerberos Hub option, and copy-paste the credentials from your Kerbero - 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). +- 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.