SUSE® Rancher Prime Agent Options
Rancher deploys an agent on each node to communicate with the node. This pages describes the options that can be passed to the agent. To use these options, you will need to create a cluster with custom nodes and add the options to the generated docker run
command when adding a node.
For an overview of how Rancher communicates with downstream clusters using node agents, refer to the architecture section.
General options
Parameter | Environment variable | Description |
---|---|---|
|
|
The configured Rancher |
|
|
Token that is needed to register the node in Rancher |
|
|
The SHA256 checksum of the configured Rancher |
|
|
Override the hostname that is used to register the node (defaults to |
|
|
Add node labels to the node. For multiple labels, pass additional |
|
|
Add node taints to the node. For multiple taints, pass additional |
Role options
Parameter | Environment variable | Description |
---|---|---|
|
|
Apply all roles ( |
|
|
Apply the role |
|
|
Apply the role |
|
|
Apply the role |
IP address options
Parameter | Environment variable | Description |
---|---|---|
|
|
The IP address the node will be registered with (defaults to the IP used to reach |
|
|
The IP address used for inter-host communication on a private network |
Dynamic IP address options
For automation purposes, you can’t have a specific IP address in a command as it has to be generic to be used for every node. For this, we have dynamic IP address options. They are used as a value to the existing IP address options. This is supported for --address
and --internal-address
.
Value | Example | Description |
---|---|---|
Interface name |
|
The first configured IP address will be retrieved from the given interface |
|
|
Value retrieved from |
|
|
Value retrieved from |
|
|
Value retrieved from |
|
|
Value retrieved from |
|
|
Value retrieved from |
|
|
Value retrieved from |
|
|
Value retrieved from |
|
|
Value retrieved from |
|
|
Value retrieved from |
|
|
Value retrieved from |
|
|
Value retrieved from |