Difference between revisions of "Node Deployment config.ini"

From Internet Computer Wiki
Jump to: navigation, search
(Created page with "= node_reward_type Documentation = The '''node_reward_type''' parameter in the <code>config.ini</code> file indicates the specific node type for which the node operator expec...")
 
m
 
(5 intermediate revisions by one other user not shown)
Line 8: Line 8:
 
* Common examples include: <code>type1</code>, <code>type1.1</code>, <code>type3</code>, <code>type3.1</code>, etc.
 
* Common examples include: <code>type1</code>, <code>type1.1</code>, <code>type3</code>, <code>type3.1</code>, etc.
  
== How to Determine Your node_reward_type ==
+
== How to determine your node_reward_type ==
 
1. Use the <code>ic-admin</code> CLI tool to inspect your node operator configuration. For example:
 
1. Use the <code>ic-admin</code> CLI tool to inspect your node operator configuration. For example:
 
   <pre>ic-admin --nns-url https://ic0.app get-node-operator &lt;your_node_operator_id&gt;</pre>
 
   <pre>ic-admin --nns-url https://ic0.app get-node-operator &lt;your_node_operator_id&gt;</pre>
Line 14: Line 14:
 
   <pre>rewardable_nodes: {"type1": 28}</pre>
 
   <pre>rewardable_nodes: {"type1": 28}</pre>
 
This means <code>type1</code> is a valid and approved node type for your account.
 
This means <code>type1</code> is a valid and approved node type for your account.
 +
 
3. If multiple types are listed, select the one that best matches your node’s intended reward category.
 
3. If multiple types are listed, select the one that best matches your node’s intended reward category.
  
== Possible Values ==
+
Example invocation with <code>ic-admin</code>:
 +
<syntaxhighlight lang="bash">
 +
❯ ic-admin --nns-url https://ic0.app get-node-operator c5ssg-eh22p-pmsn6-fpjzj-k5nql-mx5mc-7gb4a-4klco-c4f37-ydnfp-bae
 +
Using NNS URLs: ["https://ic0.app/"]
 +
Fetching the most recent value for key: node_operator_record_c5ssg-eh22p-pmsn6-fpjzj-k5nql-mx5mc-7gb4a-4klco-c4f37-ydnfp-bae
 +
Most recent version is 44799. Value:
 +
NodeOperator { node_operator_principal_id: c5ssg-eh22p-pmsn6-fpjzj-k5nql-mx5mc-7gb4a-4klco-c4f37-ydnfp-bae, node_allowance: 3, node_provider_principal_id: i7dto-bgkj2-xo5dx-cyrb7-zkk5y-q46eh-gz6iq-qkgyc-w4qte-scgtb-6ae, dc_id: "bu1", rewardable_nodes: {"type0": 0, "type1": 28}, ipv6: None }
 +
</syntaxhighlight>
 +
 
 +
Alternatively, you can obtain the node_reward_type that is already set in the registry for the particular DC by using the [https://dfinity.github.io/dre/getting-started.html dre tool]. For instance:
 +
 
 +
<syntaxhighlight lang="bash">
 +
dre registry --filter=dc_id=<dc_id>
 +
</syntaxhighlight> to get the node operator record associated with the DC. Please replace `<dc_id>` with your DC, e.g. `bu1`.
 +
 
 +
== Possible values ==
 
The NNS Registry configuration determines which types are valid. Examples:
 
The NNS Registry configuration determines which types are valid. Examples:
* <code>type1</code>
+
* <code>node_reward_type=type1</code>
* <code>type1.1</code>
+
*<code>node_reward_type=type1.1</code>
* <code>type3</code>
+
*<code>node_reward_type=type3</code>
* <code>type3.1</code>
+
*<code>node_reward_type=type3.1</code>
 
    
 
    
 
The set of valid types may change as the community updates NNS configurations. You may get the entire latest reward table list by running:
 
The set of valid types may change as the community updates NNS configurations. You may get the entire latest reward table list by running:
Line 37: Line 53:
 
If left unset or set to an invalid value, the node registration may fail or may succeed but you may not get rewards for the node.
 
If left unset or set to an invalid value, the node registration may fail or may succeed but you may not get rewards for the node.
  
== Best Practices ==
+
== How to check ==
* Ensure <code>node_reward_type</code> in <code>config.ini</code> matches a type listed under <code>rewardable_nodes</code> for your operator ID.
+
Check the node reward type at any time by invoking:
* Check the node reward settings for the node operator in case of any problems
 
* Check the node reward type at any time by invoking:
 
  
 
   ic-admin --nns-url https://ic0.app get-node <node-id>
 
   ic-admin --nns-url https://ic0.app get-node <node-id>
 +
 +
Example node record:
 +
 +
  Using NNS URLs: ["https://ic0.app/"]
 +
  Fetching the most recent value for key: node_record_fvy7i-ux7is-cuvfm-2n2zh-5lpb4-oe2vz-bfnhz-oi5s5-jkzhk-phlj2-gqe
 +
  Most recent version is 44039. Value:
 +
  Node { xnet: Some("[2800:c20:0:29:6801:29ff:fe18:1f08]:2497"), http: Some("[2800:c20:0:29:6801:29ff:fe18:1f08]:8080"),
 +
  node_operator_id: eqv2i-6dtlf-bhbjd-2popw-vvavp-7xzci-6gdd7-qxgox-wdw5w-l3a4w-eae, chip_id: None, hostos_version_id:
 +
  Some("2e269c77aa2f6b2353ddad6a4ac3d5ddcac196b1"), public_ipv4_config: None, domain: None, node_reward_type: None }
 +
 +
In this case the <code>node_reward_type</code> for the node is set to None, which means that the node will not get any rewards. The quickest way to resolve this problem is to make changes in the <code>config.ini</code> and redeploy the node.
 +
 +
== Best practices ==
 +
* Ensure <code>node_reward_type</code> in <code>config.ini</code> matches a type listed under <code>rewardable_nodes</code> for your operator ID.
 +
* Check the node reward settings for the node operator and for the node in case of any problems

Latest revision as of 18:17, 19 December 2024

node_reward_type Documentation

The node_reward_type parameter in the config.ini file indicates the specific node type for which the node operator expects to receive rewards. This value must correspond to a recognized and community-approved node type defined in the Network Nervous System (NNS).

What is node_reward_type?

  • It specifies the node’s reward category.
  • The chosen type must be compatible with the configurations listed in the NNS node rewards table.
  • Common examples include: type1, type1.1, type3, type3.1, etc.

How to determine your node_reward_type

1. Use the ic-admin CLI tool to inspect your node operator configuration. For example:

ic-admin --nns-url https://ic0.app get-node-operator <your_node_operator_id>

2. In the output, look for the `rewardable_nodes` field. It might look like:

rewardable_nodes: {"type1": 28}

This means type1 is a valid and approved node type for your account.

3. If multiple types are listed, select the one that best matches your node’s intended reward category.

Example invocation with ic-admin:

❯ ic-admin --nns-url https://ic0.app get-node-operator c5ssg-eh22p-pmsn6-fpjzj-k5nql-mx5mc-7gb4a-4klco-c4f37-ydnfp-bae
Using NNS URLs: ["https://ic0.app/"]
Fetching the most recent value for key: node_operator_record_c5ssg-eh22p-pmsn6-fpjzj-k5nql-mx5mc-7gb4a-4klco-c4f37-ydnfp-bae
Most recent version is 44799. Value:
NodeOperator { node_operator_principal_id: c5ssg-eh22p-pmsn6-fpjzj-k5nql-mx5mc-7gb4a-4klco-c4f37-ydnfp-bae, node_allowance: 3, node_provider_principal_id: i7dto-bgkj2-xo5dx-cyrb7-zkk5y-q46eh-gz6iq-qkgyc-w4qte-scgtb-6ae, dc_id: "bu1", rewardable_nodes: {"type0": 0, "type1": 28}, ipv6: None }

Alternatively, you can obtain the node_reward_type that is already set in the registry for the particular DC by using the dre tool. For instance:

dre registry --filter=dc_id=<dc_id>

to get the node operator record associated with the DC. Please replace `<dc_id>` with your DC, e.g. `bu1`.

Possible values

The NNS Registry configuration determines which types are valid. Examples:

  • node_reward_type=type1
  • node_reward_type=type1.1
  • node_reward_type=type3
  • node_reward_type=type3.1

The set of valid types may change as the community updates NNS configurations. You may get the entire latest reward table list by running:

 ic-admin --nns-urls https://ic0.app get-rewards-table

Or for the particular Node Operator record with:

 ic-admin --nns-url https://ic0.app get-node-operator <node-operator-id>

If you do not set node_reward_type

If node_reward_type is empty, you should not expect to get rewards for the node, after March 2025.

Default value

If left unset or set to an invalid value, the node registration may fail or may succeed but you may not get rewards for the node.

How to check

Check the node reward type at any time by invoking:

 ic-admin --nns-url https://ic0.app get-node <node-id>

Example node record:

 Using NNS URLs: ["https://ic0.app/"]
 Fetching the most recent value for key: node_record_fvy7i-ux7is-cuvfm-2n2zh-5lpb4-oe2vz-bfnhz-oi5s5-jkzhk-phlj2-gqe
 Most recent version is 44039. Value:
 Node { xnet: Some("[2800:c20:0:29:6801:29ff:fe18:1f08]:2497"), http: Some("[2800:c20:0:29:6801:29ff:fe18:1f08]:8080"), 
 node_operator_id: eqv2i-6dtlf-bhbjd-2popw-vvavp-7xzci-6gdd7-qxgox-wdw5w-l3a4w-eae, chip_id: None, hostos_version_id: 
 Some("2e269c77aa2f6b2353ddad6a4ac3d5ddcac196b1"), public_ipv4_config: None, domain: None, node_reward_type: None }

In this case the node_reward_type for the node is set to None, which means that the node will not get any rewards. The quickest way to resolve this problem is to make changes in the config.ini and redeploy the node.

Best practices

  • Ensure node_reward_type in config.ini matches a type listed under rewardable_nodes for your operator ID.
  • Check the node reward settings for the node operator and for the node in case of any problems