README
¶
Getting Started
Documentation
Open Horizon documentation repository coming soon! For the time being, you can learn more about Open Horizon here.
Management Hub Installation
Before you can publish and use any of the services in this repository, you must first deploy your own Horizon Management Hub. This can be done with one simple command using the deploy-mgmt-hub.sh script located in the devops repository. This will give you with a management hub with several services, policies and patterns published in the exchange.
Register an Edge Node with your Mangement Hub
In order to deploy a service to an edge node it must first be registered with a management hub. The agent-install.sh script is a fast and easy way to register an edge node with a management hub, more information can be found in the open-horizon/anax repository. Edge nodes can be either a device or a cluster. Open Horizon edge cluster capability helps you manage and deploy workloads from a management hub cluster to remote instances of OpenShift® Container Platform or other Kubernetes-based clusters.
Typically, edge devices have a prescriptive purpose, provide (often limited) compute capabilities, and are located near or at the data source. Currently supported edge device OS and architectures:
- x86_64
- Linux x86_64 devices or virtual machines that run Ubuntu 20.x (focal), Ubuntu 18.x (bionic), Debian 10 (buster), Debian 9 (stretch)
- Red Hat Enterprise Linux® 8.2
- Fedora Workstation 32
- CentOS 8.2
- SuSE 15 SP2
- ppc64le (support starting Horizon version 2.28)
- Red Hat Enterprise Linux® 7.9
- ARM (32-bit)
- Linux on ARM (32-bit), for example Raspberry Pi, running Raspberry Pi OS buster or stretch
- ARM (64-bit)
- Linux on ARM (64-bit), for example NVIDIA Jetson Nano, TX1, or TX2, running Ubuntu 18.x (bionic)
- Mac
- macOS
Open Horizon edge cluster capability helps you manage and deploy workloads from a management hub cluster to remote instances of OpenShift® Container Platform or other Kubernetes-based clusters. Edge clusters are edge nodes that are Kubernetes clusters. An edge cluster enables use cases at the edge, which require colocation of compute with business operations, or that require more scalability, availability, and compute capability than what can be supported by an edge device. Further, it is not uncommon for edge clusters to provide application services that are needed to support services running on edge devices due to their close proximity to edge devices. Open Horizon deploys edge services to an edge cluster, via a Kubernetes operator, enabling the same autonomous deployment mechanisms used with edge devices. The full power of Kubernetes as a container management platform is available for edge services that are deployed by Open Horizon. Currently supported edge cluster architectures:
- OCP on x86_64 platforms
- K3s - Lightweight Kubernetes
- MicroK8s on Ubuntu 18.04 (for development and test, not recommended for production)
Currently there is only one example service in this repository that is designed to run on an edge cluster and that is the nginx-operator.
Example Services
During the management hub installation, several services should have been published into the exchange automatically. The following three command will list the services, patterns, and deployment policies available in your exchange:
hzn exchange service list IBM/
hzn exchange pattern list IBM/
hzn exchange deployment listpolicy
Note: The above commands assume you have the Horizon environment variables HZN_ORG_ID and HZN_EXCHANGE_USER_AUTH set.
You can find a list of available edge services in this repository located in the edge/services directory. For the most part, each of the services are broken up into micro-services designed to accomplish one specific task. This makes them easier to incorporate into a wide variety of "top-level" services.
A good example of a "top-level" service is cpu2evtstreams, which has two dependent services (cpu_percent, and gps). It uses these two micro-services to gather information about the edge node it is running on and sends it to an instance of IBM Event Streams using kafkacat.
Edge examples specific to the Watson IoT Platform are found in edge/wiotp. These examples are not being maintained.
Using Example Services
Each example service in this repo has a README that includes steps to run it when it is currently published in your exchange, or a "Create your own" set of instructions that will guide you through the process of publishing your own version to your exchange.
Directories
¶
| Path | Synopsis |
|---|---|
|
cloud
|
|
|
edge
|
|
|
services/gps/src
Horizon GPS Data REST API This REST server enables workload access to static location or dynamic GPS receiver location and satellite data.
|
Horizon GPS Data REST API This REST server enables workload access to static location or dynamic GPS receiver location and satellite data. |
|
services/gps/src/envutil
envutil -- utilities for getting configuration from environment variables.
|
envutil -- utilities for getting configuration from environment variables. |
|
services/gps/src/gpsdc
gpsdc -- a Go client for the gpsd daemon Usage example: package main import ( "fmt" "gpsdc" ) func main() { var gps_monitor *gpsdc.Session var err error // Open socket to gpsd at specified address (using default here) if gps_monitor, err = gpsdc.Dial(gpsdc.DefaultAddress); err != nil { panic(fmt.Sprintf("Failed to connect to GPSD: ", err)) } // Add an inline Filter function gps_monitor.AddFilter("TPV", func (r interface{}) { report := r.(*gpsdc.TPVReport) fmt.Printf("TPV: Lat=%f, Lon=%f, Alt=%f\n", report.Lat, report.Lon, report.Alt) }) // Or a stand-alone Filter function skyfilter := func(r interface{}) { sky := r.(*gpsdc.SKYReport) fmt.Printf("SKY: %d satellites\n", len(sky.Satellites)) } gps_monitor.AddFilter("SKY", skyfilter) // Tell gpsdc to start watching (using the default watch command here) gps_monitor.SendCommand(gpsdc.DefaultWatchCommand) // Listen forever for reports (delivered to the Filters above) done := gps_monitor.Listen() <- done } This code is Based on the incomplete and apparently abandoned 2013 project: "https://github.com/stratoberry/go-gpsd" The majority of this code was copied directly from that project.
|
gpsdc -- a Go client for the gpsd daemon Usage example: package main import ( "fmt" "gpsdc" ) func main() { var gps_monitor *gpsdc.Session var err error // Open socket to gpsd at specified address (using default here) if gps_monitor, err = gpsdc.Dial(gpsdc.DefaultAddress); err != nil { panic(fmt.Sprintf("Failed to connect to GPSD: ", err)) } // Add an inline Filter function gps_monitor.AddFilter("TPV", func (r interface{}) { report := r.(*gpsdc.TPVReport) fmt.Printf("TPV: Lat=%f, Lon=%f, Alt=%f\n", report.Lat, report.Lon, report.Alt) }) // Or a stand-alone Filter function skyfilter := func(r interface{}) { sky := r.(*gpsdc.SKYReport) fmt.Printf("SKY: %d satellites\n", len(sky.Satellites)) } gps_monitor.AddFilter("SKY", skyfilter) // Tell gpsdc to start watching (using the default watch command here) gps_monitor.SendCommand(gpsdc.DefaultWatchCommand) // Listen forever for reports (delivered to the Filters above) done := gps_monitor.Listen() <- done } This code is Based on the incomplete and apparently abandoned 2013 project: "https://github.com/stratoberry/go-gpsd" The majority of this code was copied directly from that project. |
|
services/gps/src/hgps
hgps -- a resource class for caching Horizon GPS data Cache your Horizon GPS data in a "smart" GpsCache instance.
|
hgps -- a resource class for caching Horizon GPS data Cache your Horizon GPS data in a "smart" GpsCache instance. |