Difference between revisions of "Node Provider Onboarding"

From Internet Computer Wiki
Jump to: navigation, search
m
 
(215 intermediate revisions by 16 users not shown)
Line 1: Line 1:
<span id="becoming-a-node-provider"></span>
+
Learn how to be accepted by the NNS as a Node Provider and onboard your nodes to the IC.
= Becoming a Node Provider =
 
  
To participate in the Internet Computer network as a [[TODO:%20link|Node Provider]] and receive the rewards for supporting the network.
+
Please allocate up to a week to complete this guide, as it may take several days for a proposal to be accepted by the NNS, and you may have to submit multiple NNS proposals.  
  
<span id="requirements"></span>
+
'''Note that the following steps do not need to be performed on the node machine itself.''' You can complete them on your personal laptop.
== Requirements ==
 
  
* [https://support.internetcomputer.org/hc/en-us/articles/4402245887764-What-are-the-Hardware-Requirements-to-be-a-Node-Provider- Node Hardware]
+
If you encounter issues through any of these steps, check the [[Node Provider Troubleshooting]] page. If that does not solve your problem, you are encouraged to ask for assistance in the [[Node Provider Matrix channel]].
* [https://www.ledger.com/ Hardware wallet]
 
* [https://shop.nitrokey.com/shop/product/nkhs2-nitrokey-hsm-2-7 NitroKey HSM]
 
  
<span id="setup"></span>
+
For regular operations after onboarding, please refer to [[Node Provider Maintenance Guide|Node Provider Maintenance Guide.]]
== Setup ==
 
  
<ol style="list-style-type: decimal;">
+
== '''<big>Requirements</big>''' ==
<li><p>Install the required tools</p>
+
* Assure your node(s) meet the [[Node Provider Machine Hardware Guide|Node Provider Machine Hardware requirements.]]
<ol style="list-style-type: decimal;">
+
* View the [[Node Provider Networking Guide|Node Provider Networking Guide.]]
<li><p><code>ic-admin</code> to enable you to create proposals</p>
+
* Setup a [https://www.ledger.com/ hardware wallet].
<p>MacOS:</p>
+
*[https://shop.nitrokey.com/shop/product/nkhs2-nitrokey-hsm-2-7/ NitroKey HSM] (Optional, legacy—not recommended).
<ol style="list-style-type: decimal;">
+
* 11 ICP (10 of which are to be staked for the NNS proposal deposit).
<li><p>Download ic-admin</p>
+
* Basic understanding of [[Neurons 101|neurons]], [https://internetcomputer.org/docs/current/tokenomics/nns/nns-staking-voting-rewards staking], and [[Governance of the Internet Computer|governance]] proposals, such as understanding what it means to stake a neuron for 8 years.
<syntaxhighlight lang="shell">$ curl "https://download.dfinity.systems/blessed/ic/0ef2aebde4ff735a1a93efa342dcf966b6df5061/nix-release/x86_64-darwin/ic-admin.gz" -o - | gunzip > ./ic-admin
 
$ chmod +x ./ic-admin</syntaxhighlight></li>
 
<li><p>Verify the binary</p>
 
<syntaxhighlight lang="shell">$ diff <(sha256sum ./ic-admin | cut -d' ' -f1) <(echo da20f751b705de5a75a370fa9d2c5f09e553abaa8893692104fb260b247d336d)</syntaxhighlight></li>
 
<li><p>Verify the version</p>
 
<syntaxhighlight lang="shell">$ ./ic-admin --version
 
  
ic-admin 1.0</syntaxhighlight></li></ol>
+
== 1. Install the required tools ==
 +
===''' A. Install ic-admin '''===
  
<p>Linux:</p>
+
<code>ic-admin</code> is the tool used to create and submit NNS proposals.
<ol style="list-style-type: decimal;">
 
<li><p>Download ic-admin (TODO: change to same version as above and update sha256sum)</p>
 
<syntaxhighlight lang="shell">$ curl "https://download.dfinity.systems/blessed/ic/0ef2aebde4ff735a1a93efa342dcf966b6df5061/release/ic-admin.gz" -o - | gunzip > ./ic-admin
 
$ chmod +x ./ic-admin</syntaxhighlight></li>
 
<li><p>Verify the binary</p>
 
<syntaxhighlight lang="shell">diff <(sha256sum ./ic-admin | cut -d' ' -f1) <(echo c5bf9996dd009d1eeb22c59f77ee881d4044cd8c8a040204bfc95a9b21f085f2)</syntaxhighlight></li>
 
<li><p>Verify that the version is 1.0 or greater</p>
 
<syntaxhighlight lang="shell">$ ./ic-admin --version
 
  
ic-admin 1.0</syntaxhighlight></li></ol>
+
==== MacOS ====
</li>
+
# To install <code>ic-admin</code>, view the latest release version in the [https://github.com/dfinity/ic/releases/latest DFINITY/ic repo]. Then, use the following URL <syntaxhighlight lang="shell">
<li><p><code>dfx</code> to enable you to generate a neuron hotkey</p>
+
$ curl -L "https://github.com/dfinity/ic/releases/download/[latest-release]/ic-admin-x86_64-darwin.gz" -o - | gunzip > ./ic-admin
<ol style="list-style-type: decimal;">
+
$ chmod +x ./ic-admin
<li><p>Install dfx</p>
+
</syntaxhighlight>Replace <code>[latest-release]</code> with the most recent IC version, such as <code>release-2024-07-10_23-01-base</code>.
<syntaxhighlight lang="shell">$ sh -ci "$(curl -fsSL https://sdk.dfinity.org/install.sh)"</syntaxhighlight></li>
+
# Verify the binary <syntaxhighlight lang="shell">
<li><p>Verify that the version is 0.8.1 or greater</p>
+
$ diff <(shasum -a 256 ./ic-admin | cut -d' ' -f1) <(echo 035abf8925bf54e067d13eee0a6205e883507d6138bcd232ec8069301a9b190a) && echo "ic-admin checksum matches" || echo "***ERROR***: ic-admin checksum does not match"
<syntaxhighlight lang="shell">$ dfx --version
+
</syntaxhighlight>
  
dfx 0.8.1</syntaxhighlight></li></ol>
+
==== Linux ====
</li></ol>
+
NOTE: The instructions below have been tested with the Ubuntu 20.04 release.
</li>
+
# To install <code>ic-admin</code>, view the latest release version in the [https://github.com/dfinity/ic/releases/latest DFINITY/ic repo]. Then, use the following URL <syntaxhighlight lang="shell">
<li><p>Create a wallet hotkey principal</p>
+
$ curl -L "https://github.com/dfinity/ic/releases/download/[latest-release]/ic-admin-x86_64-linux.gz" -o - | gunzip > ./ic-admin
<syntaxhighlight lang="shell">$ dfx identity new node-provider-hotkey
+
$ chmod +x ./ic-admin
 +
</syntaxhighlight>Replace <code>[latest-release]</code> with the most recent IC version, such as <code>release-2024-07-10_23-01-base</code>.
 +
# Verify the binary <syntaxhighlight lang="shell">
 +
$ diff <(shasum -a 256 ./ic-admin | cut -d' ' -f1) <(echo e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855) && echo "ic-admin checksum matches" || echo "***ERROR***: ic-admin checksum does not match"
 +
</syntaxhighlight>
 +
 
 +
===''' B. Install dfx '''===
 +
 
 +
#<code>dfx</code> is a CLI tool used to generate neuron hotkeys, among other things such as canister deployment and management. <syntaxhighlight lang="shell">
 +
$ sh -ci "$(curl -fsSL https://internetcomputer.org/install.sh)"
 +
 
 +
</syntaxhighlight>
 +
#Verify that <code>dfx</code> is up to date. <syntaxhighlight lang="shell">
 +
$ export PATH=$HOME/bin:$PATH
 +
$ dfx upgrade
 +
$ dfx --version
 +
</syntaxhighlight>
 +
 
 +
==2. Create Node Provider hotkey ==
 +
 
 +
#Create an identity for the Node Provider h'''otkey''' <syntaxhighlight lang="shell">
 +
$ dfx identity new --storage-mode=plaintext node-provider-hotkey
  
Creating identity: "node-provider-hotkey".
 
 
Created identity: "node-provider-hotkey".
 
Created identity: "node-provider-hotkey".
 +
  
 
$ dfx --identity node-provider-hotkey identity get-principal
 
$ dfx --identity node-provider-hotkey identity get-principal
  
wuyst-x5tpn-g5wri-mp3ps-vjtba-de3xs-w5xgb-crvek-tucbe-o5rqi-mae</syntaxhighlight></li>
+
xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxx
<li><p>Create and Manage Neuron via NNS Dapp and Internet Identity</p>
+
# example node-provider-hotkey: wuyst-x5tpn-g5wri-mp3ps-vjtba-de3xs-w5xgb-crvek-tucbe-o5rqi-mae
<ol style="list-style-type: decimal;">
+
 
<li>Setup your hardware wallet: https://medium.com/dfinity/integrating-ledger-nano-with-the-nns-front-end-dapp-user-manual-9c5600925e16</li>
+
</syntaxhighlight>'''You will need the Node Provider hotkey in the next steps.'''
<li>Send at least 2 ICPs to the hardware wallet address.</li>
+
 
<li>Create a neuron
+
 
<ol style="list-style-type: decimal;">
+
 
<li>Navigate to Neurons tab and create a Neuron by staking 1 ICP from your hardware wallet, and confirming the transaction on your hardware wallet. [[File:/docs/stake_neuron_1.png|stake neuron]]</li>
+
'''Note''': The Node Provider hotkey is NOT the Node Provider principal. This is the hotkey that is used for the NNS proposal submissions only.
<li>After the neuron has been created successfully, confirm to add NNS Dapp as hotkey in the dialogue and on your hardware wallet, and close the dialog after the action completes. [[File:/docs/stake_neuron_2.png|confirm hotkey]]</li>
 
<li>You will now see a neuron listed with its ID. You’ll need the neuron ID in the next steps to place the necessary proposals. [[File:/docs/neuron_id.png|neuron id]]</li></ol>
 
</li>
 
<li>Add a hotkey
 
<ol style="list-style-type: decimal;">
 
<li>Select the neuron you just created to open neuron management view and press “Add hotkey” button. [[File:/docs/hotkey_1.png|add hotkey button]]</li>
 
<li>A dialog will pop up where you can enter the principal you generated in step 2.2. Press the confirm button and confirm the transactions on your hardware wallet. [[File:/docs/hotkey_2.png|confirm hotkey]]</li></ol>
 
</li>
 
<li>Get the hardware principal id
 
<ol style="list-style-type: decimal;">
 
<li>Navigate back to ICP page and select your hardware wallet account. [[File:/docs/node_provider_principal_1.png|hardware wallet account]]</li>
 
<li>Here you can get your node provider principal by clicking on the copy icon after the principal id. You’ll need it in the next steps. [[File:/docs/node_provider_principal_2.png|hardware wallet account]]</li></ol>
 
</li></ol>
 
</li>
 
<li><p>Configure your HSM</p>
 
<ol style="list-style-type: decimal;">
 
<li><p>Install the necessary tools:</p>
 
<p>MacOS:</p>
 
<ol style="list-style-type: decimal;">
 
<li>Download this OpenSC binary: https://github.com/OpenSC/OpenSC/releases/download/0.22.0/OpenSC-0.22.0.dmg</li>
 
<li>Double click the DMG image that you downloaded and then double click the OpenSC PKG file.</li>
 
<li>If your system doesn’t allow the installation software from an unidentified developer please follow these steps or contact your system administrator:
 
<ol style="list-style-type: decimal;">
 
<li>Choose the Apple menu &gt; System Preferences &gt; click Security and Privacy.</li>
 
<li>Click the lock Icon to unlock it, then enter an administrator name and password.</li>
 
<li>Ensure that you’re on the tab named “General”.</li>
 
<li>You should see the OpenSC app and you should be able to enable its installation by choosing “Open anyway”.</li></ol>
 
</li>
 
<li>Click continue and install until the installation is complete.</li></ol>
 
  
<p>Linux:</p>
+
'''Note''': You may be prompted to enter a passphrase when creating your identity and accessing your identity principal. Take note of the passphrase you choose.
<ol style="list-style-type: decimal;">
 
<li><p>Install pcscd and opensc</p>
 
<syntaxhighlight lang="shell">sudo apt install pcscd opensc</syntaxhighlight></li></ol>
 
</li>
 
<li><p>Setup the HSM</p>
 
<ol style="list-style-type: decimal;">
 
<li><p>Initialize the HSM</p>
 
<syntaxhighlight lang="shell">sc-hsm-tool --initialize --so-pin 3537363231383830 --pin 648219</syntaxhighlight></li>
 
<li><p>Change the HSM so pin</p>
 
<syntaxhighlight lang="shell">pkcs11-tool --login --login-type so --so-pin 3537363231383830 --change-pin</syntaxhighlight></li>
 
<li><p>Create a keypair on the HSM. Enter the default pin 648219 when prompted.</p>
 
<syntaxhighlight lang="shell">pkcs11-tool -k --key-type EC:prime256v1 --login -d 01</syntaxhighlight></li></ol>
 
</li>
 
<li><p>Get the node operator principal</p>
 
<ol style="list-style-type: decimal;">
 
<li><p>Configure dfx identity (skip this step if you already configured it for an other HSM).</p>
 
<blockquote><p>Warning: Depending on your installation, the path to the <code>--hsm-pkcs11-lib-path</code> might be different. You can locate it with the following command:</p>
 
<syntaxhighlight lang="shell">find / -name opensc-pkcs11.so 2> /dev/null</syntaxhighlight></blockquote>
 
<p>MacOS:</p>
 
<syntaxhighlight lang="shell">dfx identity new hsm --hsm-key-id 01 --hsm-pkcs11-lib-path /Library/OpenSC/lib/opensc-pkcs11.so</syntaxhighlight>
 
<p>Linux:</p>
 
<syntaxhighlight lang="shell">dfx identity new hsm --hsm-key-id 01 --hsm-pkcs11-lib-path /usr/lib/x86_64-linux-gnu/opensc-pkcs11.so</syntaxhighlight></li>
 
<li><p>Get the principal. Enter the default pin 648219 when prompted.</p>
 
<syntaxhighlight lang="shell">$ echo -n PIN:; read -s DFX_HSM_PIN; export DFX_HSM_PIN; echo; dfx --identity hsm identity get-principal; unset DFX_HSM_PIN
 
  
PIN:
+
==3. Create and Manage Neuron via NNS Frontend Dapp and Internet Identity==
uqquy-76uhn-2mys5-xa3j3-oynfv-rrorc-pygn7-dldbd-4dr6n-lbhz7-zqe</syntaxhighlight></li></ol>
+
 
</li></ol>
+
#Send at least 11 ICP tokens to your hardware wallet address.
</li>
+
#Navigate to the Neurons tab and create a Neuron by staking at least 10 ICP from your hardware wallet. Staking more ICP is acceptable, but 10 is the minimum needed for this process, and you must have a little more for transaction fees.
<li><p>Register your NP principal to the network</p>
+
#<u>IMPORTANT!</u> Confirm the transaction on your hardware wallet.
<p>Replace the <code>--proposer</code> argument value with your neuron ID from step 3.1.3., <code>--node-provider-pid</code> with your NP principal from step 3.5.2, and ‘My Company’, with the name of the entity that will provide the nodes.</p>
+
#:[[File:-docs-stake_neuron_1.png|1024px|stake neuron]]
<syntaxhighlight lang="shell">NODE_PROVIDER_NAME="My Company"
+
#After the Neuron has been created successfully, confirm to "Add NNS Dapp as hotkey" in the dialogue and on your hardware wallet, and close the dialog after the action completes.
./ic-admin \
+
#:[[File:-docs-stake_neuron_2.png|1024px|neuron id]]
         --nns-url https://nns.ic0.app \
+
#Set the dissolve delay to at least 6 months, and confirm the choice in the dialogue and on your hardware wallet. After the action completes, you can close the "Follow Neurons".
 +
#:[[File:dissolve_delay.png|480px|neuron id]]
 +
#You will now see a Neuron listed with its ID. Copy the Neuron ID, since you will need it in the next steps to place the necessary proposals.
 +
#:[[File:Neuron id.png|1024px]]
 +
 
 +
==4. Add hotkeys==
 +
 
 +
#Select the Neuron you just created to open Neuron management view and press “Add hotkey” button.
 +
#:[[File:Hotkey 1.png|873x873px]]
 +
# A dialog will pop up where you can enter the hotkey you generated in step 2.1 (output from command <code>dfx --identity node-provider-hotkey identity get-principal</code>). This will allow you to submit NNS proposals using <code>ic-admin</code> and will not be used for anything else.<br>
 +
#:Press the '''confirm''' button and confirm the transactions on your hardware wallet.<br>
 +
#:[[File:Hotkey 2.png|899x899px]]
 +
#Get the Ledger Hardware Wallet Principal Id: Navigate back to ICP page and select your Ledger hardware wallet account. You will need to use this Ledger Hardware Wallet principal as the Node Provider principal in order to get the rewards directly into the secure hardware wallet.
 +
#:[[File:Node provider principal 1.png|1024px]]
 +
#:[[File:Node provider principal 2.png|800px]]
 +
#Copy and save this Node Provider principal by clicking on the copy icon after the principal id. You'll need it in the next steps. <syntaxhighlight lang="shell">
 +
$ NODE_PROVIDER_PRINCIPAL=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxx 
 +
# Input ledger Hardware Wallet principal, from the NNS FrontEnd dapp https://nns.ic0.app/
 +
 
 +
# example: $ NODE_PROVIDER_PRINCIPAL=fharn-5vyi2-4xb4a-64yyi-3jpmj-pga23-mxy25-d5uim-fqcro-eoefh-tae
 +
</syntaxhighlight>
 +
 
 +
==5. Choose onboarding path (HSM vs no HSM)==
 +
Onboarding '''without''' a NitroKey HSM is the current onboarding path. In particular, node providers onboarding [[Node Provider Machine Hardware Guide|Gen 2 hardware]] must onboard '''without''' a NitroKey HSM. If you will be onboarding '''without''' a NitroKey HSM, continue to the next step. 
 +
 
 +
If the legacy procedure is required for your onboarding (which should only be the case in rare and exceptional situations), follow the [[NitroKey HSM onboarding instructions]] and then '''return to step 8.'''
 +
 
 +
==6. Setup the Node Operator keys ==
 +
#'''''Ensure dfx is at least version 0.14.''''' Node Operator keys created with older versions of dfx '''will fail to join the IC'''.  Run:<syntaxhighlight lang="bash">
 +
$ dfxvm update
 +
$ dfx --version
 +
</syntaxhighlight>
 +
#Create a new principal with dfx:<syntaxhighlight lang="shell">
 +
$ dfx identity new --storage-mode=plaintext node_operator
 +
</syntaxhighlight>
 +
#Confirm <code>node_operator</code> identity was created successfully:<syntaxhighlight lang="shell">
 +
$ dfx identity list
 +
</syntaxhighlight>This list ''should'' contain <code>node_operator</code>.
 +
#Copy new key to a known location:<syntaxhighlight lang="shell">
 +
$ cp ~/.config/dfx/identity/node_operator/identity.pem ./node_operator_private_key.pem
 +
</syntaxhighlight>
 +
#Check the contents of the <code>node_operator_private_key.pem</code> file and double check that it contains the following contents. It is imperative that the first line has <code>-----BEGIN EC PRIVATE KEY-----</code>. If it does not, make sure you use the latest <code>dfx</code> version and that you followed the instructions precisely.<syntaxhighlight lang="shell">
 +
❯ cat ./node_operator_private_key.pem
 +
-----BEGIN EC PRIVATE KEY-----
 +
[3 lines of base64 encoded private key, e.g. n2Nhp68YcQpuS0u96r...]
 +
-----END EC PRIVATE KEY-----
 +
</syntaxhighlight>Note: you must retain access to the <code>node_operator_private_key.pem</code> file for when you onboard nodes in '''[https://wiki.internetcomputer.org/wiki/Node_Provider_Roadmap#Milestone_Five:_Node_Machine_Onboarding roadmap milestone five.]'''
 +
 
 +
==7. Get the node operator principal==
 +
 
 +
#Get the principal:<syntaxhighlight lang="shell">
 +
$ NODE_OPERATOR_PRINCIPAL=$(dfx --identity node_operator identity get-principal)
 +
$ echo $NODE_OPERATOR_PRINCIPAL
 +
 
 +
uqquy-76uhn-2mys5-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxx
 +
</syntaxhighlight>
 +
'''You will need the node operator principal in the next steps.'''
 +
 
 +
==8. Register your Node Provider principal to the network==
 +
In the next codeblock:
 +
*Replace the <code>NODE_PROVIDER_NAME</code> value with the name of the entity that will provide the nodes.
 +
*Replace the <code>NODE_PROVIDER_PRINCIPAL</code> value with the Ledger Hardware Wallet principal that you got from the NNS Frontend Dapp (step 4.4)
 +
*Replace the <code>NEURON_ID</code> value with your neuron ID from the NNS Frontend Dapp (step 3.6)
 +
 
 +
*'''''IMPORTANT:''''' Please make sure that you also update the <code>--summary</code> and include a link to the forum discussion, your company's web page, and/or to another place that can convince the voting community that you are making a legitimate request. You must also include the file hash for the [[Node Provider Self-declaration|self declaration and proof of identity documents]], or the proposal will be rejected. This way you will avoid the community voting NO to your proposal and you losing your staked ICPs.
 +
 
 +
##Create the Proposal <syntaxhighlight lang="shell">
 +
$ NODE_PROVIDER_NAME="My Company"
 +
$ NODE_PROVIDER_PRINCIPAL=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxx
 +
$ NEURON_ID=XXXXXXXXXXXXXXXXXXXX
 +
$ ./ic-admin \
 +
         --nns-url https://ic0.app \
 
         -s ~/.config/dfx/identity/node-provider-hotkey/identity.pem \
 
         -s ~/.config/dfx/identity/node-provider-hotkey/identity.pem \
 
     propose-to-add-or-remove-node-provider add \
 
     propose-to-add-or-remove-node-provider add \
         --proposer 13419667327548602649 \
+
         --proposer $NEURON_ID \
         --title "Register '${NODE_PROVIDER_NAME}' node provider" \
+
         --proposal-title "Register a node provider '${NODE_PROVIDER_NAME}'" \
         --summary "Register a node provider for '${NODE_PROVIDER_NAME}'" \
+
         --summary "Register a node provider '${NODE_PROVIDER_NAME}', in line with the announcement and discussion at <https://forum.dfinity.org/t/...>. The self-declaration documentation is available at <https://wiki.internetcomputer.org/wiki/...> with SHA256 hash <SHA256>. The proof of identity is available at <https://wiki.internetcomputer.org/wiki/...> with SHA256 hash <SHA256>." \
        --node-provider-pid "fharn-5vyi2-4xb4a-64yyi-3jpmj-pga23-mxy25-d5uim-fqcro-eoefh-tae"</syntaxhighlight>
+
        --node-provider-pid "$NODE_PROVIDER_PRINCIPAL"
<p>Find the proposal on https://dashboard.internetcomputer.org/governance and wait until it’s executed before proceeding to next step.</p></li>
+
</syntaxhighlight>Note: make sure <code>${NODE_PROVIDER_NAME}</code> is presented in single quotes, so the IC dashboard can pick up and display the correct Node Provider name.
<li><p>Ensure that your datacenter is registered in the network</p>
+
#Find the proposal on https://dashboard.internetcomputer.org/governance and '''wait until it is executed before proceeding to next step.'''
<ol style="list-style-type: decimal;">
+
#In order to expedite the speed of your proposal's approval, it is best to create a post in this [https://forum.dfinity.org/t/new-node-provider-proposals/16643/69 forum thread] to raise awareness of your proposal. You can use this as a [https://docs.google.com/document/d/1nKy5hKiF72a4NCHvpgij-Np9pbtR5KOBbF1W6qr-nds/edit?usp=sharing template] for the post.
<li><p>Search for your data center on https://dashboard.internetcomputer.org/centers. If you found the datacenter that’s hosting your nodes, remember its ID, and skip to step 7. Otherwise, proceed to the next step. [[File:/docs/dc_id.png|dc id]]</p></li>
 
<li><p>Create a data center record</p>
 
<p>Replace the <code>--proposer</code> argument value with your neuron ID from step 3.1.3. and JSON fields from –data-centers-to-add argument with:</p>
 
<p> <code>&quot;id&quot;</code></p>
 
<p>The ID should be combination of two letters representing a city that your datacenter is in, and an incrementing number. Search data center IDs on https://dashboard.internetcomputer.org, and find a combination of two letters and a number that’s not yet registered. [[File:/docs/dc_id.png|dc id]]</p>
 
<p> Examples:</p>
 
<ul>
 
<li>dl1 (Dallas, no IDs with “dl” prefix)</li>
 
<li>zh10 (Zurich, numbers 0-9 are already registered)</li></ul>
 
  
<p> <code>&quot;region&quot;</code></p>
 
<p>Region represents the local region of a datacenter and is formulated as a three-part string divided by commas. The three parts making the string are continent, country code, and region, in the given order. [[File:/docs/datacenter_region.png|datacenter region]]</p>
 
<p> Examples:</p>
 
<ul>
 
<li>North America,US,Florida</li>
 
<li>Europe,DE,Bavaria</li>
 
<li>Asia,SG,Singapore</li></ul>
 
  
<p> <code>&quot;owner&quot;</code> The entity that provides your datacenter facilities. Search https://dashboard.internetcomputer.org for existing data center providers. If there’s match, make sure you use the same exact some name for your datacenter. Otherwise, name the data center owner to your best knowledge. [[File:/docs/datacenter_owner.png|datacenter owner]]</p>
+
''See guide for [[Troubleshooting Failed NNS proposals]]''
<p> <code>&quot;gps&quot;</code></p>
 
<p>Find your datacenter on https://www.google.com/maps/. Right click on location, and select the GPS coordinates (first item in the menu) in order to copy them.</p>
 
[[File:/docs/maps.png|thumb|none|alt=Getting GPS coordinates|Getting GPS coordinates]]
 
  
<syntaxhighlight lang="shell">$ ./ic-admin \
+
==9. Register your datacenter to the network (if necessary)==
         --nns-url https://nns.ic0.app \
+
#Search for your data center on https://dashboard.internetcomputer.org/centers.
 +
#*If you found the datacenter that is hosting your nodes, remember its ID, and skip the following section. Otherwise, proceed with the registration of a new DC record.
 +
#:[[File:dc_id.png|1041x1041px|alt=]]
 +
===Create a data center record for a new DC===
 +
In the next block of code:
 +
*Replace the <code>NEURON_ID</code> value with your neuron ID from the NNS Frontend Dapp (step 3.6)
 +
*Replace the JSON fields from the <code>–data-centers-to-add</code> argument and their corresponding values in <code>--summary</code>:
 +
**<code>&quot;id&quot;</code> represents the city that your datacenter is in and is formulated as a combination of two letters representing the city and an incrementing number. Search data center IDs on https://dashboard.internetcomputer.org, and find a combination of two letters and a number that’s not yet registered. Examples:
 +
***dl1 (Dallas, no IDs with “dl” prefix)
 +
***zh10 (Zurich, numbers 0-9 are already registered)
 +
**:[[File:dc_id.png|1024px]]
 +
**<code>&quot;region&quot;</code> represents the local region of a datacenter and is formulated as a three-part string divided by commas. The three parts making the string are continent, country code, and region, in the given order. Examples:
 +
***North America,US,Florida
 +
***Europe,DE,Bavaria
 +
***Asia,SG,Singapore
 +
**:[[File:datacenter_region.png|1024px]]
 +
**<code>&quot;owner&quot;</code> The entity that provides your datacenter facilities.
 +
***Search https://dashboard.internetcomputer.org for existing data center providers.
 +
*** If there’s match, make sure you use the same exact some name for your datacenter.
 +
***Otherwise, name the data center owner to your best knowledge.
 +
**:[[File:datacenter_owner.png|1024px]]
 +
**<code>&quot;gps&quot;</code> GPS coordinates.
 +
***Find your datacenter on https://www.google.com/maps/.
 +
***Right click on location, and select the GPS coordinates (first item in the menu) in order to copy them.
 +
**:[[File:maps.png|310x310px|alt=Getting GPS coordinates|Getting GPS coordinates]]
 +
 
 +
#Create the proposal: <syntaxhighlight lang="shell">
 +
$ NEURON_ID=XXXXXXXXXXXXXXXXXXXX
 +
$ ./ic-admin \
 +
         --nns-url https://ic0.app \
 
         -s ~/.config/dfx/identity/node-provider-hotkey/identity.pem \
 
         -s ~/.config/dfx/identity/node-provider-hotkey/identity.pem \
 
     propose-to-add-or-remove-data-centers \
 
     propose-to-add-or-remove-data-centers \
 +
        --summary "Register a Flexential datacenter as dl1 in North America,US,Texas" \
 
         --skip-confirmation \
 
         --skip-confirmation \
         --proposer 13419667327548602649 \
+
         --proposer $NEURON_ID \
 
         --data-centers-to-add '{
 
         --data-centers-to-add '{
 
             "id": "dl1",
 
             "id": "dl1",
Line 178: Line 210:
 
                 33.00803, -96.66614
 
                 33.00803, -96.66614
 
             ]
 
             ]
         }'</syntaxhighlight>
+
         }'
<p>Find the proposal on https://dashboard.internetcomputer.org/governance and wait until it’s executed before proceeding to next step.</p></li></ol>
+
</syntaxhighlight>'''Remember to replace all the values of both the arguments <code>–data-centers-to-add</code> and <code>--summary</code>'''
</li>
+
#Find the proposal on https://dashboard.internetcomputer.org/governance and wait until it's executed before proceeding to next step.
<li><p>Create a node operator record</p>
+
#In order to expedite the speed of your proposal's approval, it is best to create a post in this [https://forum.dfinity.org/t/new-node-provider-proposals/16643/69 forum thread] to raise awareness of your proposal. You can use this as a [https://docs.google.com/document/d/1Hg0tI9O5__Tp4qKrNKuTADsQT7Z47I6aAFXbiDimG_U/edit?usp=sharing template] for the post.
<p>Replace the <code>--proposer</code> argument value with your neuron ID from step 3.1.3., <code>--dc-id</code> argument with id of your datacenter from step 6, <code>--node-allowance</code> argument with number of nodes you’re providing, <code>--node-operator-principal-id</code> argument with the principal from step 4.3.2, and the first positional argument (<code>fharn-5vyi2-4xb4a-64yyi-3jpmj-pga23-mxy25-d5uim-fqcro-eoefh-tae</code>) with your node provider principal from step 3.5.2.</p>
+
 
<syntaxhighlight lang="shell">$ ./ic-admin \
+
 
         --nns-url https://nns.ic0.app \
+
''See guide for [[Troubleshooting Failed NNS proposals]]''
 +
 
 +
==10. Create a node operator record==
 +
'''''IMPORTANT''':'' Before submitting the Node Operator record, please go through the description of [[Validation of Candidate Node Machines]] to validate whether additional node machines are needed for decentralization of the IC-network.
 +
 
 +
* Create a pdf with the outcome of running the optimization model and the steps that allow the community to reproduce the validation check.
 +
* Include the pdf in the wiki page that includes the NP documents (self-declaration and proof-of-identity document)
 +
* Include a link to the pdf as well as the hash of the document in the Node Operator record proosal.
 +
 
 +
 
 +
In the next codeblock:
 +
*Replace the <code>NEURON_ID</code> value with your neuron ID from the NNS Frontend Dapp (step 3.6).
 +
*Replace the <code>NODE_PROVIDER_PRINCIPAL</code> value with the Ledger Hardware Wallet principal that you got from the NNS Frontend Dapp (step 4.4).
 +
*Replace the <code>NODE_OPERATOR_PRINCIPAL</code> value with your node operator principal (step 7.1). '''Important''': if you are adding an additional node operator record because you will deploy nodes in another data center, please make sure to create a new node operator principal first (steps 6 and 7). A node operator principal can only be tied to 1 data center.
 +
*Replace the <code>NODE_PROVIDER_NAME</code> value with the name of the entity that will provide the nodes.
 +
*Replace the <code>NODE_ALLOWANCE</code> variable value with number of nodes you are providing.
 +
* Replace the <code>DC_ID</code> variable value with id of your datacenter.
 +
 
 +
# Create the proposal: <syntaxhighlight lang="shell">
 +
$ NEURON_ID=XXXXXXXXXXXXXXXXXXXX
 +
$ NODE_PROVIDER_PRINCIPAL=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxx
 +
$ NODE_OPERATOR_PRINCIPAL=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxx
 +
$ NODE_PROVIDER_NAME="My Company"
 +
$ NODE_ALLOWANCE=8
 +
$ DC_ID=dl1
 +
 
 +
$ ./ic-admin \
 +
         --nns-url https://ic0.app \
 
         -s ~/.config/dfx/identity/node-provider-hotkey/identity.pem \
 
         -s ~/.config/dfx/identity/node-provider-hotkey/identity.pem \
 
     propose-to-add-node-operator \
 
     propose-to-add-node-operator \
         fharn-5vyi2-4xb4a-64yyi-3jpmj-pga23-mxy25-d5uim-fqcro-eoefh-tae \
+
         $NODE_PROVIDER_PRINCIPAL \
         --proposer 13419667327548602649 \
+
        --summary "Node provider '$NODE_PROVIDER_NAME' is adding $NODE_ALLOWANCE nodes in the $DC_ID data center. The result of the canidate node machine validation and exact configuration run is available at <https://wiki.internetcomputer.org/wiki/...> with SHA256 hash <SHA256>." \
         --node-operator-principal-id uqquy-76uhn-2mys5-xa3j3-oynfv-rrorc-pygn7-dldbd-4dr6n-lbhz7-zqe \
+
         --proposer $NEURON_ID \
         --node-allowance 28 \
+
         --node-operator-principal-id $NODE_OPERATOR_PRINCIPAL \
         --dc-id dl2</syntaxhighlight>
+
         --node-allowance $NODE_ALLOWANCE \
<p>Find the proposal on https://dashboard.internetcomputer.org/governance and wait until it’s executed before proceeding to next step.</p></li>
+
         --dc-id $DC_ID
<li><p>Configure firewall rules</p>
+
</syntaxhighlight>
<p>Replace the <code>PROPOSER</code> variable value with your neuron ID from step 3.1.3., <code>NODES_IPV6_PREFIX</code> variable value with IPv6 prefix of the network of your nodes, <code>NODE_OPERATOR_PRINCIPAL</code> variable value with the principal from step 4.3.2.</p>
+
#Find the proposal on https://dashboard.internetcomputer.org/governance and wait until it's executed before proceeding to next step.
<syntaxhighlight lang="shell">PROPOSER=13419667327548602649
 
NODES_IPV6_PREFIX=2001:4d78:700:10a::/64
 
NODE_OPERATOR_PRINCIPAL=uqquy-76uhn-2mys5-xa3j3-oynfv-rrorc-pygn7-dldbd-4dr6n-lbhz7-zqe
 
 
 
NFTABLES=$(./ic-admin --nns-url "https://nns.ic0.app" get-firewall-config | grep "firewall_config" | cut -d':' -f2 | cut -c2- | rev | cut -c2- | rev | xargs printf)
 
IPV6_PREFIXES=$(./ic-admin --nns-url "https://nns.ic0.app" get-firewall-config | tr -d '\n' | grep -oE 'ipv6_prefixes: \[[^]]+' | cut -d'[' -f2 | tr -d '"' | tr -d ' ' | tr -d '\n'; echo $NODES_IPV6_PREFIX)
 
  
./ic-admin \
 
        --nns-url https://nns.ic0.app \
 
        -s ~/.config/dfx/identity/node-provider-hotkey/identity.pem \
 
    propose-to-set-firewall-config \
 
        --proposer $PROPOSER \
 
        --summary "Set the firewall rules for node operator ${NODE_OPERATOR_PRINCIPAL}" \
 
        <(echo $NFTABLES) \
 
        - \
 
        $IPV6_PREFIXES</syntaxhighlight>
 
<p>Find the proposal on https://dashboard.internetcomputer.org/governance and wait until it’s executed before proceeding to next step.</p></li>
 
<li><p>Onboard nodes</p>
 
<ol style="list-style-type: decimal;">
 
<li><p>Follow the instructions to [[TODO:%20link%20to%20the%20new%20wiki%20page%20which%20will%20have%20contents%20of%20these%20two%20docs:%20https://docs.google.com/presentation/d/1H6J3LKkgphKC_GRrBrltEsbWSA3kJcTfkzRt9sTovkc/edit,%20https://docs.google.com/presentation/d/1FSzh_eHIDd0w-YCRfEQSTlfoSSut3IIVoZgj-eiT8Bs|onboard new nodes]].</p></li>
 
<li><p>Verify that all the nodes were successfully onboarded by checking their status on the dashboard is set to either “Up” or “Unassigned”. You can find all your nodes by entering your node provider principal from step 3.5.2. in the search bar. [[File:/docs/onboarded_nodes.png|onboarded nodes]]</p></li></ol>
 
</li>
 
<li><p>Set the reward configuration for your nodes</p>
 
<p>Replace the <code>--proposer</code> argument value with your neuron ID from step 3.1.3., <code>--node-operator-id</code> argument with the principal from step 4.3.2, <code>&lt;NODE_X_PRINCIPAL&gt;</code> placeholders with your node principals from step 9.2., and <code>&lt;number-of-nodes&gt;</code> placeholder with the number of nodes you listed.</p>
 
<pre>$ ./ic-admin \
 
        --nns-url https://nns.ic0.app \
 
        -s ~/.config/dfx/identity/node-provider-hotkey/identity.pem \
 
    propose-to-update-node-operator-config \
 
        --proposer 13419667327548602649 \
 
        --summary &quot;Set rewards for the following nodes:
 
  
        * &lt;NODE_1_PRINCIPAL&gt;
+
''See guide for [[Troubleshooting Failed NNS proposals]]''
        * &lt;NODE_2_PRINCIPAL&gt;
 
        * ...
 
        &quot; \
 
        --node-operator-id uqquy-76uhn-2mys5-xa3j3-oynfv-rrorc-pygn7-dldbd-4dr6n-lbhz7-zqe \
 
        --rewardable-nodes '{&quot;type0&quot;: &lt;number-of-nodes&gt;}'</pre></li></ol>
 

Latest revision as of 16:11, 1 September 2024

Learn how to be accepted by the NNS as a Node Provider and onboard your nodes to the IC.

Please allocate up to a week to complete this guide, as it may take several days for a proposal to be accepted by the NNS, and you may have to submit multiple NNS proposals.

Note that the following steps do not need to be performed on the node machine itself. You can complete them on your personal laptop.

If you encounter issues through any of these steps, check the Node Provider Troubleshooting page. If that does not solve your problem, you are encouraged to ask for assistance in the Node Provider Matrix channel.

For regular operations after onboarding, please refer to Node Provider Maintenance Guide.

Requirements

1. Install the required tools

A. Install ic-admin

ic-admin is the tool used to create and submit NNS proposals.

MacOS

  1. To install ic-admin, view the latest release version in the DFINITY/ic repo. Then, use the following URL
    $ curl -L "https://github.com/dfinity/ic/releases/download/[latest-release]/ic-admin-x86_64-darwin.gz" -o - | gunzip > ./ic-admin
    $ chmod +x ./ic-admin
    
    Replace [latest-release] with the most recent IC version, such as release-2024-07-10_23-01-base.
  2. Verify the binary
    $ diff <(shasum -a 256 ./ic-admin | cut -d' ' -f1) <(echo 035abf8925bf54e067d13eee0a6205e883507d6138bcd232ec8069301a9b190a) && echo "ic-admin checksum matches" || echo "***ERROR***: ic-admin checksum does not match"
    

Linux

NOTE: The instructions below have been tested with the Ubuntu 20.04 release.

  1. To install ic-admin, view the latest release version in the DFINITY/ic repo. Then, use the following URL
    $ curl -L "https://github.com/dfinity/ic/releases/download/[latest-release]/ic-admin-x86_64-linux.gz" -o - | gunzip > ./ic-admin
    $ chmod +x ./ic-admin
    
    Replace [latest-release] with the most recent IC version, such as release-2024-07-10_23-01-base.
  2. Verify the binary
    $ diff <(shasum -a 256 ./ic-admin | cut -d' ' -f1) <(echo e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855) && echo "ic-admin checksum matches" || echo "***ERROR***: ic-admin checksum does not match"
    

B. Install dfx

  1. dfx is a CLI tool used to generate neuron hotkeys, among other things such as canister deployment and management.
    $ sh -ci "$(curl -fsSL https://internetcomputer.org/install.sh)"
    
  2. Verify that dfx is up to date.
    $ export PATH=$HOME/bin:$PATH
    $ dfx upgrade
    $ dfx --version
    

2. Create Node Provider hotkey

  1. Create an identity for the Node Provider hotkey
    $ dfx identity new --storage-mode=plaintext node-provider-hotkey
    
    Created identity: "node-provider-hotkey".
    
    
    $ dfx --identity node-provider-hotkey identity get-principal
    
    xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxx
    # example node-provider-hotkey: wuyst-x5tpn-g5wri-mp3ps-vjtba-de3xs-w5xgb-crvek-tucbe-o5rqi-mae
    
    You will need the Node Provider hotkey in the next steps.


Note: The Node Provider hotkey is NOT the Node Provider principal. This is the hotkey that is used for the NNS proposal submissions only.

Note: You may be prompted to enter a passphrase when creating your identity and accessing your identity principal. Take note of the passphrase you choose.

3. Create and Manage Neuron via NNS Frontend Dapp and Internet Identity

  1. Send at least 11 ICP tokens to your hardware wallet address.
  2. Navigate to the Neurons tab and create a Neuron by staking at least 10 ICP from your hardware wallet. Staking more ICP is acceptable, but 10 is the minimum needed for this process, and you must have a little more for transaction fees.
  3. IMPORTANT! Confirm the transaction on your hardware wallet.
    stake neuron
  4. After the Neuron has been created successfully, confirm to "Add NNS Dapp as hotkey" in the dialogue and on your hardware wallet, and close the dialog after the action completes.
    neuron id
  5. Set the dissolve delay to at least 6 months, and confirm the choice in the dialogue and on your hardware wallet. After the action completes, you can close the "Follow Neurons".
    neuron id
  6. You will now see a Neuron listed with its ID. Copy the Neuron ID, since you will need it in the next steps to place the necessary proposals.
    Neuron id.png

4. Add hotkeys

  1. Select the Neuron you just created to open Neuron management view and press “Add hotkey” button.
    Hotkey 1.png
  2. A dialog will pop up where you can enter the hotkey you generated in step 2.1 (output from command dfx --identity node-provider-hotkey identity get-principal). This will allow you to submit NNS proposals using ic-admin and will not be used for anything else.
    Press the confirm button and confirm the transactions on your hardware wallet.
    Hotkey 2.png
  3. Get the Ledger Hardware Wallet Principal Id: Navigate back to ICP page and select your Ledger hardware wallet account. You will need to use this Ledger Hardware Wallet principal as the Node Provider principal in order to get the rewards directly into the secure hardware wallet.
    Node provider principal 1.png
    Node provider principal 2.png
  4. Copy and save this Node Provider principal by clicking on the copy icon after the principal id. You'll need it in the next steps.
    $ NODE_PROVIDER_PRINCIPAL=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxx   
    # Input ledger Hardware Wallet principal, from the NNS FrontEnd dapp https://nns.ic0.app/
    
    # example: $ NODE_PROVIDER_PRINCIPAL=fharn-5vyi2-4xb4a-64yyi-3jpmj-pga23-mxy25-d5uim-fqcro-eoefh-tae
    

5. Choose onboarding path (HSM vs no HSM)

Onboarding without a NitroKey HSM is the current onboarding path. In particular, node providers onboarding Gen 2 hardware must onboard without a NitroKey HSM. If you will be onboarding without a NitroKey HSM, continue to the next step.

If the legacy procedure is required for your onboarding (which should only be the case in rare and exceptional situations), follow the NitroKey HSM onboarding instructions and then return to step 8.

6. Setup the Node Operator keys

  1. Ensure dfx is at least version 0.14. Node Operator keys created with older versions of dfx will fail to join the IC. Run:
    $ dfxvm update
    $ dfx --version
    
  2. Create a new principal with dfx:
    $ dfx identity new --storage-mode=plaintext node_operator
    
  3. Confirm node_operator identity was created successfully:
    $ dfx identity list
    
    This list should contain node_operator.
  4. Copy new key to a known location:
    $ cp ~/.config/dfx/identity/node_operator/identity.pem ./node_operator_private_key.pem
    
  5. Check the contents of the node_operator_private_key.pem file and double check that it contains the following contents. It is imperative that the first line has -----BEGIN EC PRIVATE KEY-----. If it does not, make sure you use the latest dfx version and that you followed the instructions precisely.
    ❯ cat ./node_operator_private_key.pem
    -----BEGIN EC PRIVATE KEY-----
    [3 lines of base64 encoded private key, e.g. n2Nhp68YcQpuS0u96r...]
    -----END EC PRIVATE KEY-----
    
    Note: you must retain access to the node_operator_private_key.pem file for when you onboard nodes in roadmap milestone five.

7. Get the node operator principal

  1. Get the principal:
    $ NODE_OPERATOR_PRINCIPAL=$(dfx --identity node_operator identity get-principal)
    $ echo $NODE_OPERATOR_PRINCIPAL
    
    uqquy-76uhn-2mys5-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxx
    

You will need the node operator principal in the next steps.

8. Register your Node Provider principal to the network

In the next codeblock:

  • Replace the NODE_PROVIDER_NAME value with the name of the entity that will provide the nodes.
  • Replace the NODE_PROVIDER_PRINCIPAL value with the Ledger Hardware Wallet principal that you got from the NNS Frontend Dapp (step 4.4)
  • Replace the NEURON_ID value with your neuron ID from the NNS Frontend Dapp (step 3.6)
  • IMPORTANT: Please make sure that you also update the --summary and include a link to the forum discussion, your company's web page, and/or to another place that can convince the voting community that you are making a legitimate request. You must also include the file hash for the self declaration and proof of identity documents, or the proposal will be rejected. This way you will avoid the community voting NO to your proposal and you losing your staked ICPs.
    1. Create the Proposal
      $ NODE_PROVIDER_NAME="My Company"
      $ NODE_PROVIDER_PRINCIPAL=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxx
      $ NEURON_ID=XXXXXXXXXXXXXXXXXXXX
      $ ./ic-admin \
              --nns-url https://ic0.app \
              -s ~/.config/dfx/identity/node-provider-hotkey/identity.pem \
          propose-to-add-or-remove-node-provider add \
              --proposer $NEURON_ID \
              --proposal-title "Register a node provider '${NODE_PROVIDER_NAME}'" \
              --summary "Register a node provider '${NODE_PROVIDER_NAME}', in line with the announcement and discussion at <https://forum.dfinity.org/t/...>. The self-declaration documentation is available at <https://wiki.internetcomputer.org/wiki/...> with SHA256 hash <SHA256>. The proof of identity is available at <https://wiki.internetcomputer.org/wiki/...> with SHA256 hash <SHA256>." \
              --node-provider-pid "$NODE_PROVIDER_PRINCIPAL"
      
      Note: make sure ${NODE_PROVIDER_NAME} is presented in single quotes, so the IC dashboard can pick up and display the correct Node Provider name.
  1. Find the proposal on https://dashboard.internetcomputer.org/governance and wait until it is executed before proceeding to next step.
  2. In order to expedite the speed of your proposal's approval, it is best to create a post in this forum thread to raise awareness of your proposal. You can use this as a template for the post.


See guide for Troubleshooting Failed NNS proposals

9. Register your datacenter to the network (if necessary)

  1. Search for your data center on https://dashboard.internetcomputer.org/centers.
    • If you found the datacenter that is hosting your nodes, remember its ID, and skip the following section. Otherwise, proceed with the registration of a new DC record.

Create a data center record for a new DC

In the next block of code:

  • Replace the NEURON_ID value with your neuron ID from the NNS Frontend Dapp (step 3.6)
  • Replace the JSON fields from the –data-centers-to-add argument and their corresponding values in --summary:
    • "id" represents the city that your datacenter is in and is formulated as a combination of two letters representing the city and an incrementing number. Search data center IDs on https://dashboard.internetcomputer.org, and find a combination of two letters and a number that’s not yet registered. Examples:
      • dl1 (Dallas, no IDs with “dl” prefix)
      • zh10 (Zurich, numbers 0-9 are already registered)
      Dc id.png
    • "region" represents the local region of a datacenter and is formulated as a three-part string divided by commas. The three parts making the string are continent, country code, and region, in the given order. Examples:
      • North America,US,Florida
      • Europe,DE,Bavaria
      • Asia,SG,Singapore
      Datacenter region.png
    • "owner" The entity that provides your datacenter facilities.
      • Search https://dashboard.internetcomputer.org for existing data center providers.
      • If there’s match, make sure you use the same exact some name for your datacenter.
      • Otherwise, name the data center owner to your best knowledge.
      Datacenter owner.png
    • "gps" GPS coordinates.
      • Find your datacenter on https://www.google.com/maps/.
      • Right click on location, and select the GPS coordinates (first item in the menu) in order to copy them.
      Getting GPS coordinates
  1. Create the proposal:
    $ NEURON_ID=XXXXXXXXXXXXXXXXXXXX
    $ ./ic-admin \
            --nns-url https://ic0.app \
            -s ~/.config/dfx/identity/node-provider-hotkey/identity.pem \
        propose-to-add-or-remove-data-centers \
            --summary "Register a Flexential datacenter as dl1 in North America,US,Texas" \
            --skip-confirmation \
            --proposer $NEURON_ID \
            --data-centers-to-add '{
                "id": "dl1",
                "region": "North America,US,Texas",
                "owner": "Flexential",
                "gps": [
                    33.00803, -96.66614
                ]
            }'
    
    Remember to replace all the values of both the arguments –data-centers-to-add and --summary
  2. Find the proposal on https://dashboard.internetcomputer.org/governance and wait until it's executed before proceeding to next step.
  3. In order to expedite the speed of your proposal's approval, it is best to create a post in this forum thread to raise awareness of your proposal. You can use this as a template for the post.


See guide for Troubleshooting Failed NNS proposals

10. Create a node operator record

IMPORTANT: Before submitting the Node Operator record, please go through the description of Validation of Candidate Node Machines to validate whether additional node machines are needed for decentralization of the IC-network.

  • Create a pdf with the outcome of running the optimization model and the steps that allow the community to reproduce the validation check.
  • Include the pdf in the wiki page that includes the NP documents (self-declaration and proof-of-identity document)
  • Include a link to the pdf as well as the hash of the document in the Node Operator record proosal.


In the next codeblock:

  • Replace the NEURON_ID value with your neuron ID from the NNS Frontend Dapp (step 3.6).
  • Replace the NODE_PROVIDER_PRINCIPAL value with the Ledger Hardware Wallet principal that you got from the NNS Frontend Dapp (step 4.4).
  • Replace the NODE_OPERATOR_PRINCIPAL value with your node operator principal (step 7.1). Important: if you are adding an additional node operator record because you will deploy nodes in another data center, please make sure to create a new node operator principal first (steps 6 and 7). A node operator principal can only be tied to 1 data center.
  • Replace the NODE_PROVIDER_NAME value with the name of the entity that will provide the nodes.
  • Replace the NODE_ALLOWANCE variable value with number of nodes you are providing.
  • Replace the DC_ID variable value with id of your datacenter.
  1. Create the proposal:
    $ NEURON_ID=XXXXXXXXXXXXXXXXXXXX
    $ NODE_PROVIDER_PRINCIPAL=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxx
    $ NODE_OPERATOR_PRINCIPAL=xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxxxx-xxx
    $ NODE_PROVIDER_NAME="My Company"
    $ NODE_ALLOWANCE=8
    $ DC_ID=dl1
    
    $ ./ic-admin \
            --nns-url https://ic0.app \
            -s ~/.config/dfx/identity/node-provider-hotkey/identity.pem \
        propose-to-add-node-operator \
            $NODE_PROVIDER_PRINCIPAL \
            --summary "Node provider '$NODE_PROVIDER_NAME' is adding $NODE_ALLOWANCE nodes in the $DC_ID data center. The result of the canidate node machine validation and exact configuration run is available at <https://wiki.internetcomputer.org/wiki/...> with SHA256 hash <SHA256>." \
            --proposer $NEURON_ID \
            --node-operator-principal-id $NODE_OPERATOR_PRINCIPAL \
            --node-allowance $NODE_ALLOWANCE \
            --dc-id $DC_ID
    
  2. Find the proposal on https://dashboard.internetcomputer.org/governance and wait until it's executed before proceeding to next step.


See guide for Troubleshooting Failed NNS proposals