Skip to content
This repository was archived by the owner on May 4, 2021. It is now read-only.

added troubleshooting section #1

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 50 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,62 @@
# tutum-node

Run your Tutum node inside a container!

Get your `<token>` by clicking on `Bring your own node` in Tutum's [Nodes dashboard](https://dashboard.tutum.co/node/cluster/list/)

## Usage (using Docker)

Run your Tutum node inside a container!

docker run -d --net=host --privileged --restart=always -e TUTUM_TOKEN=<token> tutum/node

## Usage (using Vagrant)

Run your Tutum node inside a Vagrant box!

vagrant init tutum/node
TUTUM_TOKEN=<token> vagrant up

## Troubleshooting

### Re-register a node after an unintended shutdown

Use-case: Your Vagrant VM or underlying machine was experiencing a hard shutdown and your node remains *unreachable*, i.e. after
a server crash.

In some cases a node might not be able to re-register itself correctly with tutum, to trigger a reconnection of a VM
with an existing node entry, follow these steps:

Login to the node

ssh mynode

restart the `tutum-agent` with this command.

service tutum-agent restart

Check the logs if needed, the node may need about 1-2 minutes to come up again.

tail -f /var/log/tutum/agent.log

### Re-register with existing parameters

If you're still experiencing issues, like [this one](https://github.com/tutumcloud/tutum-node/pull/1).

Aquire your API token from your [account info page](https://dashboard.tutum.co/account/)

export TUTUM_API_TOKEN=12345abcde12345abcde12345abcde12345abcde

Go to the [cluster list](https://dashboard.tutum.co/node/cluster/list/) and get the `BYON_TOKEN` from the modal after clicking the `Bring your own node` button.

export TUTUM_BYON_TOKEN=f1e2d3c4b5af1e2d3c4b5af1e2d3c4bc

Get the UUID of the node by navigating to it's URL in the [cluster list](https://dashboard.tutum.co/node/cluster/list/).
Use the last part of the URL without the slash.

export TUTUM_NODE_UUID=1a2b3c4d-5f6a-0e0d-1a2b-1234567890ab

Set the API token value and run the command from the modal window in the Web UI. *Hint: You can also show the command with `tutum-cli`*

sudo tutum-agent set TutumToken=$TUTUM_API_TOKEN
curl -Ls https://get.tutum.co/ | sudo -H sh -s $TUTUM_BYON_TOKEN $TUTUM_NODE_UUID '*.node.tutum.io'

Check the logs, your node should register with the API under it's existing identifier.