Skip to content

Commit

Permalink
Merge pull request #11 from adi6496/master
Browse files Browse the repository at this point in the history 
Fixed Gstreamer Script, fixed some minor issues, Add comments about each command, add Kafka bridge access via Route or ingress
  • Loading branch information
Andrew Stoycos committed May 14, 2020
2 parents 9809cb2 + 6b629b6 commit 79bb311
Show file tree
Hide file tree
Showing 31 changed files with 301 additions and 88 deletions.
50 changes: 27 additions & 23 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Persistent storage is implemented using [Ceph Object Storage](https://ceph.io/ce
### On Edge

#### Gstreamer
Gstreamer AI plugin to run analytics on low resource devices @Aditya
Gstreamer is an open source multimedia framework for managing media files and real time streaming using camera. This project leverages gstreamer capabilities with CNN model based enchanced analytics from OpenVino toolkit by Intel. This can be used to perform HLS video streaming with various use cases such as object detection, classification, recognition and tracking.

#### TensorFlow lite

Expand All @@ -82,25 +82,29 @@ Persistent storage is implemented using [Ceph Object Storage](https://ceph.io/ce

## Command Reference

| Command1 (Tool) | Command2(Module) | Command3(Module command) | Argument (module input) | Flags | Function |
|-------------------|------------------|--------------------------|-------------------------------------|--------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| ceph | destroy | None | None | None | Destroy the ceph object store instance on the cluster |
| ceph | user | None | `<User Name>` | None | Create an Ceph Object Store User |
| ceph | secrets | None | `<User Name>` | None | Return user secrets for ceph deployment |
| ceph | setup | None | None | None | Setup Ceph Object Storage via the Rook Operator |
| enmasse | destroy | None | None | None | Remove Enmasse from openshift cluster |
| enmasse | IoT | addDevice | `<Messaging Tenant>`, `<DeviceID>` | None | Add a Device with specified ID to the Enmasse device registry for a specified messaging TenantSetup default Credentials |
| enmasse | IoT | project | None | --namespace | Make a new enmasse IoT project in the specified namespace, defaults to “myapp” |
| enmasse | setup | None | None | None | Download Enmasse Source, store in current directory. Setup Enmasse Setup IoT services |
| kafka | bridge | None | None | --namespace | Deploy kafka HTTP bridge Deploy nginx ingress to access bridge from outside the cluster (will be transitioned to a route) |
| kafka | destroy | None | None | --namespace | Destroy the kafka deployment located at the specified namespace |
| kafka | setup | None | None | --namespace | Setup a kafka cluster viat the strimzi operator at the specified namespace |
| knative | setup | None | None | --status=true/false | Setup Knative serverless on openshift clusterConfigures both Knative-Eventing and Knative-ServingSet --status=true to check on Knative deployment |
| knative | destroy | None | None | None | Remove Knative deployment from openshift cluster |
| knative | service | None | `<Knative service to be deployed>` | --status=true/false--namespace | Deploy a knative service Set --status=true to check on Knative service deploymentDefault namespace is “knative-eventing” |
| knative | service | destroy | `<Knative service to be destroyed>` | --namespace | Remove a specified Knative service from the cluster at specified namespace Default namespace is “knative-eventing” |
| knative | source | None | `<containersource to be deployed>` | --namespace | Deploy a Knative Source at specified namespace Defaults to namespace “knative-eventing” |
| 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” |
| Command1 (Tool) | Command2(Module) | Command3(Module command) | Argument (module input) | Flags | Function |
|-------------------|------------------|--------------------------|-------------------------------------|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | | | | | |
| ceph | destroy | None | None | None | Destroy the ceph object store instance on the cluster |
| ceph | user | None | `<User Name>` | None | Create an Ceph Object Store User |
| ceph | secrets | None | `<User name>` | None | Return user secrets for ceph deployment |
| ceph | setup | None | None | None | Setup Ceph Object Storage via the Rook Operator |
| enmasse | destroy | None | None | None | Remove Enmasse from openshift cluster |
| enmasse | IoT | addDevice | `<Messaging Tenant>`, `<DeviceID>` | None | Add a Device with specified ID to the Enmasse device registry for a specified messaging TenantSetup default Credentials |
| enmasse | IoT | project | None | --namespace | Make a new enmasse IoT project in the specified namespace, defaults to “myapp” |
| enmasse | setup | None | None | None | Download Enmasse Source, store in current directory. Setup Enmasse Setup IoT services |
| gstreamer | setup | None | None | --local=true/false | Deploy Gtsreamer with OpenVino Toolkit for video/audio streaming with analyticsSet local=True for deploying gstreamer locally |
| gstreamer | destroy | None | None | None | Destroy Gstreamer deployment |
| kafka | bridge | None | None | --namespace --route=true/false | Deploy kafka HTTP bridge Set route=True to deploy a route to access bridge from outside(only for Openshift Cluster)Default deploys nginx ingress to access bridge from outside the cluster |
| kafka | destroy | None | None | --namespace | Destroy the kafka deployment located at the specified namespace |
| kafka | setup | None | None | --namespace | Setup a kafka cluster viat the strimzi operator at the specified namespace |
| knative | setup | None | None | --status=true/false | Setup Knative serverless on openshift clusterConfigures both Knative-Eventing and Knative-ServingSet --status=true to check on Knative deployment |
| knative | destroy | None | None | None | Remove Knative deployment from openshift cluster |
| knative | service | None | `<Knative service to be deployed>` | --status=true/false--namespace | Deploy a knative service Set --status=true to check on Knative service deploymentDefault namespace is “knative-eventing” |
| knative | service | destroy | `<Knative service to be destroyed>` | --namespace | Remove a specified Knative service from the cluster at specified namespace Default namespace is “knative-eventing” |
| knative | source | None | `<containersource to be deployed>` | --namespace | Deploy a Knative Source at specified namespace Defaults to namespace “knative-eventing” |
| 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” |

2 changes: 1 addition & 1 deletion cmd/ceph-destroy.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ func cephDestroy() {
// destroyCmd represents the destroy command
var cephDestroyCmd = &cobra.Command{
Use: "destroy",
Short: "A brief description of your command",
Short: "Destroy the Ceph cluster",
Long: `A longer description that spans multiple lines and likely contains examples
and usage of using your command. For example:
Expand Down
2 changes: 1 addition & 1 deletion cmd/ceph-secrets.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ func getCredentials(user string) {
// secretsCmd represents the secrets command
var cephSecretsCmd = &cobra.Command{
Use: "secrets",
Short: "A brief description of your command",
Short: "Get S3 secrets from ceph object storage",
Long: `A longer description that spans multiple lines and likely contains examples
and usage of using your command. For example:
Expand Down
5 changes: 3 additions & 2 deletions cmd/ceph-setup.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,14 @@ limitations under the License.
package cmd

import (
"time"

"github.com/IoTCLI/cmd/utils"
log "github.com/sirupsen/logrus"
"github.com/spf13/cobra"
"k8s.io/cli-runtime/pkg/genericclioptions"
"k8s.io/kubectl/pkg/cmd/apply"
"k8s.io/kubectl/pkg/cmd/get"
"time"
)

//Made from Instructions @https://opendatahub.io/docs/administration/advanced-installation/object-storage.html for installing
Expand Down Expand Up @@ -81,7 +82,7 @@ func cephSetup() {
// setupCmd represents the setup command
var cephSetupCmd = &cobra.Command{
Use: "setup",
Short: "A brief description of your command",
Short: "Setup Ceph Object storage",
Long: `A longer description that spans multiple lines and likely contains examples
and usage of using your command. For example:
Expand Down
7 changes: 4 additions & 3 deletions cmd/ceph-user.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,14 @@ limitations under the License.
package cmd

import (
"io/ioutil"
"os"

"github.com/IoTCLI/cmd/utils"
log "github.com/sirupsen/logrus"
"github.com/spf13/cobra"
"io/ioutil"
"k8s.io/cli-runtime/pkg/genericclioptions"
"k8s.io/kubectl/pkg/cmd/apply"
"log"
"os"
)

func cephUser(user string) {
Expand Down
9 changes: 2 additions & 7 deletions cmd/ceph.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,8 @@ import (
// cephCmd represents the ceph command
var cephCmd = &cobra.Command{
Use: "ceph",
Short: "A brief description of your command",
Long: `A longer description that spans multiple lines and likely contains examples
and usage of using your command. For example:
Cobra is a CLI library for Go that empowers applications.
This application is a tool to generate the needed files
to quickly create a Cobra application.`,
Short: "Deploy Ceph object storage",
Long: `Deploy Ceph object storage`,
Run: func(cmd *cobra.Command, args []string) {
fmt.Println("ceph called")
},
Expand Down
6 changes: 4 additions & 2 deletions cmd/enmasse-IoT-addDevice.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,15 @@ import (
//"os"
"bytes"
"crypto/tls"
"github.com/spf13/cobra"
"net/http"
"strings"

"github.com/spf13/cobra"

//in package import
"github.com/IoTCLI/cmd/utils"
"k8s.io/cli-runtime/pkg/genericclioptions"

//"k8s.io/kubectl/pkg/cmd/"
"k8s.io/kubectl/pkg/cmd/get"
)
Expand Down Expand Up @@ -113,7 +115,7 @@ func device(tenant string, deviceID string) {
// addDeviceCmd represents the addDevice command
var addDeviceCmd = &cobra.Command{
Use: "addDevice",
Short: "A brief description of your command",
Short: "Add an IoT device to enmasse",
Long: `A longer description that spans multiple lines and likely contains examples
and usage of using your command. For example:
Expand Down
6 changes: 2 additions & 4 deletions cmd/enmasse-IoT-project.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,8 @@ import (
"strings"
"time"

"github.com/spf13/cobra"

//in package import
"github.com/IoTCLI/cmd/utils"
"github.com/spf13/cobra"
"k8s.io/cli-runtime/pkg/genericclioptions"
"k8s.io/kubectl/pkg/cmd/apply"
"k8s.io/kubectl/pkg/cmd/get"
Expand Down Expand Up @@ -118,7 +116,7 @@ func createProject() {
// projectCmd represents the project command
var enmasseIoTProjectCmd = &cobra.Command{
Use: "project",
Short: "A brief description of your command",
Short: "Setup enmasse project",
Long: `A longer description that spans multiple lines and likely contains examples
and usage of using your command. For example:
Expand Down
2 changes: 1 addition & 1 deletion cmd/enmasse-IoT.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import (
// IoTCmd represents the IoT command
var enmasseIoTCmd = &cobra.Command{
Use: "IoT",
Short: "A brief description of your command",
Short: "Setup Enmasse IoT project",
Long: `A longer description that spans multiple lines and likely contains examples
and usage of using your command. For example:
Expand Down
2 changes: 1 addition & 1 deletion cmd/enmasse-destroy.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ func enmasseDestroy() {
// destroyCmd represents the destroy command
var enmasseDestroyCmd = &cobra.Command{
Use: "destroy",
Short: "A brief description of your command",
Short: "Destroy enmasse project",
Long: `A longer description that spans multiple lines and likely contains examples
and usage of using your command. For example:
Expand Down
2 changes: 1 addition & 1 deletion cmd/enmasse-setup.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ func enmasseSetup() {
// setupCmd represents the setup command
var enmasseSetupCmd = &cobra.Command{
Use: "setup",
Short: "A brief description of your command",
Short: "Setup Enmasse as a messaging backend",
Long: `A longer description that spans multiple lines and likely contains examples
and usage of using your command. For example:
Expand Down
Loading

0 comments on commit 79bb311

Please sign in to comment.