Backport kontena/kontena#2504 node token docs #12
Conversation
miskun
left a comment
miskun
left a comment
There was a problem hiding this comment.
- Create Kontena Node stuff should be moved to install-nodes/README.md and/or one of its sub documents
- New term: Kontena Agent introduced?
- Remove Kontena Node - Is there additional value of having longer story?
- Show Kontena Platform Grid Agent Configuration?
|
@jakolehm can you take a look at this as well |
using-kontena/nodes.md
Outdated
| $ kontena node show <NODE_ID> | ||
| ``` | ||
|
|
||
| ## Show Kontena Node Agent Configuration |
There was a problem hiding this comment.
Just "Show Kontena Node Configuration".
using-kontena/platform.md
Outdated
| ``` | ||
|
|
||
| ## Show Kontena Platform Grid Environment Details | ||
| ## Show Kontena Platform Grid Agent Configuration |
There was a problem hiding this comment.
"Show Kontena Platform Node Configuration"
There was a problem hiding this comment.
Hmm.. Kontena Platform Node == Kontena Node? --> Kontena Node Configuration? --> Show Kontena Node Configuration
| ## Show Kontena Node Configuration | ||
|
|
||
| Outputs currently used Kontena Platform Grid environment variables that can be used to configure Kontena CLI. | ||
| Generate the [`/etc/kontena-agent.env` environment variables](../references/environment-variables#kontena-agent) required when manually provisioning nodes using grid tokens: |
There was a problem hiding this comment.
This links to the "Kontena Agent" section on the environment variables reference. Do we also want to avoid the mention of /etc/kontena-agent.env here?
| If you are using the Kontena CLI built-in provision tool, you can terminate Kontena Node using the `kontena <provider> node terminate` command. Alternatively, power off / terminate the Kontena Node machine from any infrastructure you are using and wait for the machine to become offline before removing them. | ||
| If the node was provisioned using the Kontena CLI built-in provisioning tool, you can terminate the host machine using the `kontena <provider> node terminate` command. This will also remove the Kontena Node. If the host machine has already been terminated, then the `kontena node remove` command can be used to forget the terminated node. | ||
|
|
||
| If the node was provisioned with a node token, then the `kontena node remove` command can also be used to invalidate the node token, forcing the agent to disconnect if it is still connected. Nodes provisioned using grid tokens cannot be removed if they are still online, because the agent would simply reconnect and the node would quickly re-appear. |
There was a problem hiding this comment.
Remove Kontena Node - Is there additional value of having longer story?
There are now two kinds of nodes: those with grid tokens and those with node tokens. They behave differently in terms of kontena node remove.
The kontena <provider> node terminate is still the main preferred thing to use. Removing an online node provisioned using a node token will still leave the machine running. That implies something like you losing access to that node and wanting to kick it out of your grid ASAP.
Should we drop support for removing online nodes connected using node tokens, to simplify the docs? You could still use kontena node reset-token to force it to disconnect , and then remove it after waiting for it to go offline.
|
|
||
| ## Create Kontena Nodes | ||
|
|
||
| Create a new Kontena Node for manual provisioning: |
There was a problem hiding this comment.
Create Kontena Node stuff should be moved to install-nodes/README.md and/or one of its sub documents
So the using-kontena/nodes.md should not have any mention of kontena node create?
Writing up the detailed docs in install-nodes/README.md is still WIP, I can move this to that branch.
From kontena/kontena#2504
kontena grid envdocskontena nodecommands