From 271fd5bddc7dc9df961885c7ddc17df4b32092cc Mon Sep 17 00:00:00 2001 From: Andrew Stoycos Date: Wed, 13 May 2020 22:24:03 -0400 Subject: [PATCH] Fix top part of readme --- README.md | 33 +++++++++++++++++++++++---------- 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 7870571..f0f0aaf 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,41 @@ -# OpenShift Clients +# Setting up Clound Native Edge systems with the IoTCLI # OpenShift Clients -The OpenShift client `oc` simplifies working with Kubernetes and OpenShift + +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 The OpenShift client `oc` simplifies working with Kubernetes and OpenShift clusters, offering a number of advantages over `kubectl` such as easy login, kube config file management, and access to developer tools. The `kubectl` binary is included alongside for when strict Kubernetes compliance is necessary. -To learn more about OpenShift, visit [docs.openshift.com](https://docs.openshift.com) + +## Getting Started To learn more about OpenShift, visit [docs.openshift.com](https://docs.openshift.com) and select the version of OpenShift you are using. -## Installing the tools -After extracting this archive, move the `oc` and `kubectl` binaries +Download the latest Release from the [release page](https://github.com/redhat-iot/iot-dev/releases) ## Installing the tools + + +Move the Binary `IoTCLI` into your `$PATH` After extracting this archive, move the `oc` and `kubectl` binaries to a location on your PATH such as `/usr/local/bin`. Then run: - oc login [API_URL] -to start a session against an OpenShift cluster. After login, run `oc` and +Run `IoTCLI login` to authenticate with your Openshift cluster oc login [API_URL] + + +# Main Components Overview to start a session against an OpenShift cluster. After login, run `oc` and `oc help` to learn more about how to get started with OpenShift. -## License -OpenShift is licensed under the Apache Public License 2.0. The source code for this +## Messaging Core ## License + + +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 OpenShift is licensed under the Apache Public License 2.0. The source code for this + program is [located on github](https://github.com/openshift/origin). -he system along with its [IoT services](https://enmasse.io/documentation/0.31.0/openshift/#iot-guide-messaging-iot) onto an openshift Cluster +### Enmasse he system along with its [IoT services](https://enmasse.io/documentation/0.31.0/openshift/#iot-guide-messaging-iot) onto an openshift Cluster + +[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