diff --git a/README.md b/README.md index d0dabda..8e2247e 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,7 @@ We have documented the different deployment models [in the `deployments` directo - [Red Hat OpenShift with Ansible](https://github.com/kerberos-io/agent/tree/master/deployments#4-red-hat-ansible-and-openshift) - [Terraform](https://github.com/kerberos-io/agent/tree/master/deployments#5-terraform) - [Salt](https://github.com/kerberos-io/agent/tree/master/deployments#6-salt) -- [Balena](https://github.com/kerberos-io/agent/tree/master/deployments#1-balena) +- [Balena](https://github.com/kerberos-io/agent/tree/master/deployments#8-balena) By default your Kerberos Agents will store all its configuration and recordings inside the container. To help you automate and have a more consistent data governance, you can attach volumes to configure and persist data of your Kerberos Agents, and/or configure each Kerberos Agent through environment variables. diff --git a/deployments/balena/README.md b/deployments/balena/README.md index b9b6af9..900d0dc 100644 --- a/deployments/balena/README.md +++ b/deployments/balena/README.md @@ -4,14 +4,12 @@ Balena Cloud provide a seamless way of building and deploying applications at sc We provide two mechanisms to deploy Kerberos Agent to a Balena Cloud fleet: -1. Use Kerberos Agent as [a block part of your larger application](https://github.com/kerberos-io/balena-agent-block). -2. Use Kerberos Agent as [a stand-a-lone application](https://github.com/kerberos-io/balena-agent). +1. Use Kerberos Agent as [a block part of your application](https://github.com/kerberos-io/balena-agent-block). +2. Use Kerberos Agent as [a stand-alone application](https://github.com/kerberos-io/balena-agent). ## Block -Within Balena you can build the concept of a block, which is the equivalent of container image or a function in a typical programming language. - -The idea of blocks, you can find a more thorough explanation [here](https://docs.balena.io/learn/develop/blocks/), is that you can compose and combine multiple `blocks` to level up to the concept an `app`. +Within Balena you can build the concept of a block, which is the equivalent of container image or a function in a typical programming language. The idea of blocks, you can find a more thorough explanation [here](https://docs.balena.io/learn/develop/blocks/), is that you can compose and combine multiple `blocks` to level up to the concept an `app`. You as a developer can choose which `blocks` you would like to use, to build the desired `application` state you prefer. For example you can use the [Kerberos Agent block](https://hub.balena.io/blocks/2064662/agent) to compose a video surveillance system as part of your existing set of blocks. @@ -19,3 +17,15 @@ You can the `Kerberos Agent` block by defining following elements in your `compo agent: image: bh.cr/kerberos_io/agent + +## App + +Next to building individual `blocks` you as a developer can also decide to build up an application, composed of one or more `blocks` or third-party containers, and publish it as an `app` to the Balena Hub. This is exactly [what we've done..](https://hub.balena.io/apps/2064752/video-surveillance) + +On Balena Hub we have created the []`video-surveillance` application](https://hub.balena.io/apps/2064752/video-surveillance) that utilises the [Kerberos Agent `block`](https://hub.balena.io/blocks/2064662/agent). The idea of this application is that utilises the foundation of our Kerberos Agent, but that it might include more `blocks` over time to increase and improve functionalities from other community projects. + +To deploy the application you can simply press below `Deploy button` or you can navigate to the [Balena Hub apps page](https://hub.balena.io/apps/2064752/video-surveillance). + +[![deploy with balena](https://balena.io/deploy.svg)](https://dashboard.balena-cloud.com/deploy?repoUrl=https://github.com/kerberos-io/agent) + +You can find the source code, `balena.yaml` and `docker-compose.yaml` files in the [`balena-agent` repository](https://github.com/kerberos-io/balena-agent).