Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
astoycos committed Apr 24, 2020
1 parent 7411e06 commit e76e6c7
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# Setting up Clound Native Edge systems with the IoTCLI

The user can choose which tools they want to use in order to either digest, display or process the IoT data. Eventually the user will be allowed to create custom data pipelines to connect the tools. Currently the following tools will be supported
The user can choose which tools they want to use in order to either digest, display or process the IoT data. Eventually the user will be allowed to create custom data pipelines to connect the tools. Currently the following tools/commands are supported

## Getting Started

Download the latest Release from the [release page](https://github.com/redhat-iot/iot-dev/releases)

Move the Executable `IoTCLI` into your `$PATH`
Move the Binary `IoTCLI` into your `$PATH`

Run `IoTCLI` login to authenticate with your openshift cluster
Run `IoTCLI login` to authenticate with your Openshift cluster

# Main Components Overview

## Messaging Core

In any Edge system that incorporates IoT devices, having a scalable cloud native edge system is very important. With the `IoTCLI` you can easily deploy these messaging services to your Openshift 4.X cluster

## Enmasse
### Enmasse

[Enmasse](enmasse.io) is an open source project for managed, self-service messaging on Kubernetes.

The IoTCLI makes it easy to deploy the system along with its [IoT services](https://enmasse.io/documentation/0.31.0/openshift/#iot-guide-messaging-iot) onto an openshift Cluster

## Kafka
### Kafka

[Apache Kafka](https://kafka.apache.org/intro) is an advanced distributed streaming platform. It is deployed to your Openshift cluster using the [Strimzi operator](https://strimzi.io/)

Expand All @@ -46,7 +46,7 @@ The `IoTCLI` can install and setup Knative on an Openshift cluster, deploy Knati

- Accepts an incoming IoT video Livestream as HLS Playlist File(`.m3u8`), runs image classification using Tensorflow, and serves it back to the user via a simple web appliaction, its repo can be found [here](https://github.com/astoycos/iotKnativeSource)

`video`
`video-analytics`

- Accepts a video livestream in form of an HLS Playlist file delivered via a JSON structured to work with kafka. Sends video to Tensorflow serving module for inference, and sends inferenced video segments ceph object storage for eventual serving. Part of [2020 Summit Demo](https://github.com/redhat-iot/2020Summit-IoT-Streaming-Demo)

Expand Down Expand Up @@ -76,6 +76,7 @@ Persistent storage is implemented using [Ceph Object Storage](https://ceph.io/ce
#### TensorFlow lite

TODO


## Command Reference

Expand All @@ -99,4 +100,4 @@ Persistent storage is implemented using [Ceph Object Storage](https://ceph.io/ce
| knative | source | destroy | <containersource to be destroyed> | --namespace | Remove a specified knative source from the cluster from specified namespaceDefault namespace is “knative-eventing” |
| login | None | None | None | None | Login to your openshift cluster with the username and password |
| tensorflowServing | setup | None | None | --namespace | Deploy a tensorflow serving deployment and service Default namespace is “default” |
| tensorflowServing | destroy | None | None | --namesapce | Deploy a tensorflow serving deployment and serviceDefault namespace is “default” |
| tensorflowServing | destroy | None | None | --namesapce | Deploy a tensorflow serving deployment and serviceDefault namespace is “default” |

0 comments on commit e76e6c7

Please sign in to comment.