04-configure-anax.md

Configure the Anax Agent

This continues the instructions from Install the Open Horizon Hub Services and Build and Run the Open Horizon Hub Services and Install the Open Horizon Agent software.

Configure environment variables so the openhorizon CLI can connect to the exchange.

NOTE: Replace x.x.x.x with the actual IP address of the machine running the Open Horizon Hub Services.

export HZN_EXCHANGE_URL=http://x.x.x.x:3090/v1
export ORG_ID=testorg
export HZN_ORG_ID=testorg
export HZN_EXCHANGE_USER_AUTH=admin:adminpw
echo "export HZN_EXCHANGE_USER_AUTH='admin:adminpw'" >> ~/.bashrc
hzn exchange user list

The results of hzn exchange user list should be something like the following:

{
  "testorg/admin": {
    "admin": true,
    "email": "admin@testorg",
    "lastUpdated": "2019-08-19T12:25:06.754Z[UTC]",
    "password": "********",
    "updatedBy": "root/root"
  }
}

Next we will publish an example EdgeX service to the openhorizon hub and then tell the agent to run the service.

git clone https://github.com/joewxboy/horizon-edgex.git
cd ./horizon-edgex

First, we'll generate an RSA key pair to be used for signing the edge service. A service is one or more microservices that are deployed on an edge device as containers. A service has to be signed so that the agent can verify that autheticity of the service definition. This command will put the keys into a default location where other CLI commands know where to find them.

hzn key create -l 4096 testorg [email protected]

This will return something like:

Created keys:
        /root/.hzn/keys/service.private.key
        /root/.hzn/keys/service.public.pem

Publish the service definition to the exchange. The command will run for a bit, and will pull each container from the container registry so that it can obtain the container digest. The digest is recorded in the published service definition. This example service is composed of several EdgeX microservices.

hzn exchange service publish -P -f ./configs/service.json

Now check to ensure that the service definition was published and is available in the exchange:

hzn exchange service list

The above should respond with the following, if successful:

[
  "testorg/com.github.joewxboy.horizon.edgex_1.0.1_amd64"
]

Next, publish a pattern to the exchange. A pattern is the easiest way for a node to indicate which services it should run. Policy based service deployment is also supported, but is slightly more complex to setup.

hzn exchange pattern publish -f ./configs/pattern.json

Now check to ensure the pattern is available:

hzn exchange pattern list

It should respond with:

[
  "testorg/pattern-edgex-amd64"
]

Last, let's register the openhorizon agent with the hub, so that it will begin executing the service.

To prepare the node, manually create the volumes that will be used by the edge services:

docker volume create db-data
docker volume create log-data
docker volume create consul-data
docker volume create consul-config

(Optionally) verify the volumes have been created: docker volume list

Manually setup and open the permissions on the host directories being bound:

mkdir -p /var/run/edgex/logs
mkdir -p /var/run/edgex/data
mkdir -p /var/run/edgex/consul/data
mkdir -p /var/run/edgex/consul/config
mkdir -p /root/res
chmod -R a+rwx /var/run/edgex
chmod -R a+rwx /root/res

Copy the configuration files from the res folder in this repository to the /root/res folder on the host.

Now register the node:

hzn register -p pattern-edgex-amd64 --policy ./configs/node.policy

To confirm that your edge node is registered for the pattern, run:

hzn node list

and confirm that the response shows your node ID. and that you're configured for the testorg/pattern-edgex-amd64 pattern.

To check on the status of the agreement, use:

hzn agreement list

or to see verbose details:

hzn eventlog list

And once the agreement is finalized, you should be able to see the containers running:

sudo docker ps

---

The End