Hub-of-Hubs-sync-service

This repository contains instructions for how to deploy OpenHorizon edge sync service components as part of the Hub-of-Hubs PoC.
OpenHorizon edge sync service is used as transport layer in the PoC and have two main components:

1. Cloud Sync Service (CSS) running in the cloud. In this PoC the CSS runs in the hub of hubs.
2. Edge Sync Service (ESS) running in edge nodes. In this PoC the ESS runs in leaf hubs.

Go to the Contributing guide to learn how to get involved.

Getting Started

Cloud Sync Service (CSS)

Deploy CSS on Hub of Hubs cluster

1. Set the CSS_PORT environment variable to hold the CSS port to be used internally in the cluster.

   $ export CSS_PORT=...
   

2. Run the following command to deploy the CSS to your Hub of Hubs cluster:

   envsubst < css/css.yaml.template | kubectl apply -f -
   

edge-sync-service CSS k8s objects will be created under the namespace sync-service.

Cleanup of CSS from Hub of Hubs cluster

1. Run the following command to clean the CSS from your Hub of Hubs cluster:

   envsubst < css/css.yaml.template | kubectl delete -f -
   

Edge Sync Service (ESS)

Deploy ESS on a leaf hub cluster

1. Set the CSS_HOST environment variable to hold the CSS host.

   $ export CSS_HOST=...
   

2. Set the CSS_PORT environment variable to hold the CSS port.

   $ export CSS_PORT=...
   

3. Set the LISTENING_PORT environment variable to hold the ESS http listening port.

   $ export LISTENING_PORT=...
   

4. Set the LH_ID environment variable to hold a unique leaf-hub id.

   $ export LH_ID=...
   

5. Run the following command to deploy the ESS to your leaf hub cluster:

   envsubst < ess/ess.yaml.template | kubectl apply -f -
   

edge-sync-service ESS k8s objects will be created under the namespace sync-service.

Cleanup of ESS from a leaf hub cluster

1. Run the following command to clean the ESS from your leaf hub cluster:

   envsubst < ess/ess.yaml.template | kubectl delete -f -