FAQs about Rancher Agent/Hosts


How do I set up my hosts behind a Proxy?

To support hosts behind a proxy, you’ll need to edit the Docker daemon to point to the proxy. The detailed instructions are listed within our adding custom host page.

What are reasons why Rancher agent would fail to start?

Adding in --name rancher-agent

If you edited the docker run .... rancher/agent... command from the UI to add in --name rancher-agent, then Rancher agent will fail to start. Rancher agent launches 3 different containers after the initial run. The container launched last, named rancher-agent, is required for the Rancher agent to successfully connect with Rancher server. The other containers launched before the rancher-agent container, which are used to inspect the host and setup state, are automatically removed.

Using a cloned VM

If you cloned a VM and attempting to register the cloned VM, it will not work and throw an error in the rancher-agent logs. ERROR: Please re-register this agent. The unique ID that rancher saves in /var/lib/rancher/state will be the same for cloned VMs and unable to re-register.

The workaround for this is to run the following command on the cloned VM rm -rf /var/lib/rancher/state; docker rm -fv rancher-agent; docker rm -fv rancher-agent-state, once completed you can register the server again.

Where can I find detailed logs of the Rancher Agent container?

As of v1.6.0, running docker logs on the Rancher agent container will provide a set of all logs related to the agent.

How to check your host registration is set correctly?

If you’re having issues with Rancher Agents connect to Rancher Server, please check that your hosts are set up. When you first attempted to add a host in the Rancher UI, you had to set a Host Registration URL. The URL is used to establish a connection from your hosts to the Rancher API server. This URL must be reachable from your hosts. To verify that it is, log onto the host and execute a curl command:

curl -i <Host Registration URL you set in UI>/v1

You should get a json response. If authentication is turned on, the response code should be 401. If authentication is not turned on, the response code should be 200.

Note: Both normal HTTP connections and websocket connections (ws://) are used. If this URL points to a proxy or load balancer, make sure it is configured to handle websocket connections.

How does the host determine IP address and how can I change it? What do I do if the IP of my host has changed (due to reboot)?

When the agent connects to Rancher server, it auto detects the IP of the agent. Sometimes, the IP that is selected is not the IP that you want to use or it selects the docker bridge IP, i.e. 172.17.x.x.

Alternatively, if you’ve already registered a host and your host has a new IP after a reboot, the IP of your host in the UI will no longer match.

You can override the CATTLE_AGENT_IP setting and set the host IP to what you want.

When the host has the incorrect IP, the containers will not have access to the managed network. To get the host and all containers into the managed network, just edit the command to add in a custom host by specify the new IP as an environment variable (i.e Step 4). Run the edited command on the host. Do not stop or remove the existing agent on the host!

$ sudo docker run -d -e CATTLE_AGENT_IP=<NEW_HOST_IP> --privileged \
    -v /var/run/docker.sock:/var/run/docker.sock \
    rancher/agent:v0.8.2 http://SERVER_IP:8080/v1/scripts/xxxx

What happens if my host is deleted outside of Rancher?

If your host is deleted outside of Rancher, then Rancher server will continue to show the host until it’s removed. These hosts will initially be in Reconnecting state before moving to Disconnected state. You will be able to Delete these hosts to remove them from the UI.

If you have services that have deployed containers onto the Disconnected hosts, they will only be re-scheduled to other hosts if you have added health checks.

Why is the same host showing up in the UI multiple times?

If you are using boot2docker to add hosts, the hosts cannot persist var/lib/rancher, which is what Rancher uses to store necessary information for identify hosts.

Edit this page