open-horizon / anax

Horizon agent control system
https://open-horizon.github.io/docs/anax/docs/
Apache License 2.0
73 stars 98 forks source link

Documentation: broken cert path in anax-in-container doc example #3694

Open johnwalicki opened 1 year ago

johnwalicki commented 1 year ago

What is the current documentation state?

I'm testing an UBI9 anax-in-container that I built as part of #3628

I'm reading here: https://open-horizon.github.io/docs/anax/docs/agent_container_manual_deploy/

Example:

HZN_AGENT_IMAGE=openhorizon/amd64_anax
HZN_AGENT_IMAGE_TAG=latest
CONFIG_FILE=/etc/default/horizon
HZN_MGMT_HUB_CERT_PATH=/etc/default/horizon/agent.crt

that's fishy... Because CONFIG_FILE=/etc/default/horizon is a file. Yet in the next line HZN_MGMT_HUB_CERT_PATH=/etc/default/horizon/agent.crt its a directory.

We should correct the example so that HZN_MGMT_HUB_CERT_PATH points to the default cert path.

HZN_MGMT_HUB_CERT_PATH=/etc/horizon/agent-install.crt

Where is this stated?

No response

Why do you want to improve the statement?

No response

Proposed Statement

No response

Additional context.

No response

johnwalicki commented 1 year ago

The instructions also include some undefined env vars in the docker run

-v $DOCKER_NAME_var:/var/horizon/ \
-v $DOCKER_NAME_etc:/etc/horizon/ \
johnwalicki commented 1 year ago

The instructions also suggest:

-v $CONFIG_FILE:/etc/default/horizon:ro $HZN_MGMT_HUB_CERT_MOUNT \

This could be on two lines? Higher in the doc there is some mangled -v

HZN_MGMT_HUB_CERT_MOUNT=”-v <ssl certificate file on host>:<$HZN_MGMT_HUB_CERT_PATH>” 

Remove the angle brackets