Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Open Horizon

Overview

Open Horizon is a middleware solution designed to manage the deployment and service software lifecycle of containerized applications. It also supports an optional separation of concerns between a service and related machine learning assets by providing a separate model sync service. These solutions enable autonomous management of large fleets of edge compute nodes in various connected states.

Open Horizon allows you to install individual tools like the Management Hub control plane, the CLI for remote management using the command-line, or the anax Agent. If you would like all three installed on a single machine, use the all-in-one installation provided below.

All-in-one installation instructions

To install a simple, developer-friendly version of all the services on one device, run the following one-liner as root on an x86_64 machine running Ubuntu 24 (see all supported environments):

curl -sSL https://raw.githubusercontent.com/open-horizon/devops/master/mgmt-hub/deploy-mgmt-hub.sh | bash

anax Agent installation instructions

If you’ve been provided with credentials by an administrator and just need to install the Agent and CLI on your machine, use these steps:

  1. Log into your device and set the environment variables given to you, replacing the <placeholders> with real values applicable to you:

    export HZN_ORG_ID=<your exchange organization id>
export HZN_DEVICE_TOKEN=<specify a string value for a token>
export HZN_DEVICE_ID=<specify a string value to uniquely identify this device>
export HZN_EXCHANGE_USER_AUTH=<user id>:<password>
export HZN_EXCHANGE_URL=<management hub protocol and IP address>:3090/v1
export HZN_FSS_CSSURL=<management hub protocol and IP address>:9443/
export HZN_AGBOT_URL=<management hub protocol and IP address>:3111
export HZN_SDO_SVC_URL=<management hub protocol and IP address>:9008/api

  2. Download and run the agent-install.sh script to get the necessary files from CSS (Cloud Sync Service), install and configure the Agent, and register your edge device to run the helloworld sample edge service:

    sudo -s -E curl -sSL https://github.com/open-horizon/anax/releases/latest/download/agent-install.sh | bash -s -- -i css: -p IBM/pattern-ibm.helloworld -w '*' -T 120

  3. If the CSS on the Hub has not been populated with an Agent for your environment and/or default configuration, you may need to manually create that configuration and then use a slightly different installation technique:

    A. Create a file named agent-install.cfg and populate it with the following, replacing the <placeholders> with real values applicable to you:

    HZN_EXCHANGE_URL=<management hub protocol and IP address>:3090/v1
HZN_FSS_CSSURL=<management hub protocol and IP address>:9443/
HZN_AGBOT_URL=<management hub protocol and IP address>:3111
HZN_SDO_SVC_URL=<management hub protocol and IP address>:9008/api

    B. Download and run the agent-install.sh script to install and configure the Agent and register your edge device to run the helloworld sample edge service:

    curl -sSL https://github.com/open-horizon/anax/releases/latest/download/agent-install.sh | bash -s -- -i anax: -k ./agent-install.cfg -c css: -p IBM/pattern-ibm.helloworld -w '*' -T 120

Alternatively, see the detailed installation instructions for other methods of installing the Agent.

Common requests

👩‍💻 How to install Open Horizon

💻 How to use Open Horizon

💾 How to contribute to the Open Horizon project

🐞 How to report an issue to Open Horizon

📚 How to get support for Open Horizon

Learn more

Developer Learning Path page.

From the Getting Started Overview page.

From the Open-Horizon Project Playlist on YouTube.