Profile Change
Introduction
The nodectl utility uses profiles to learn how to connect to various Hypergraph or metagraph clusters. Each profile will define all the necessary elements to help your node connect properly.
This document will offer a simple guide on how to change from your current profile (generally the default profile used during installation) to a new predefined profile.
Understanding
This document does not cover the detailed explanation of the various components of the profiles section; however, you can access the nodectl configuration document to review a detailed explanation of the profile section.
Change Profiles
IMPORTANT
This procedure will change your profile configuration settings, replacing the existing predefined profile with a new predefined profile.
Step by Step
Assumptions
You have a node up and running with an existing configuration.
Before we begin
The ip address and .pem file are fictitious, use your own node IP and credentials.
Important
During the process of building a new profile, the configuration validator will run against your new configuration several times prior to completing the build. You may see a CONFIGURATION DID NOT VALIDATE message; however, you can safely ignore this because nodectl will correct the validation error before the build process is completed.
nodectl will show the following message below the validation issues...
Access Your Node
Log into your node via a remote session:
In our example, we connect from a Mac into our node. This is done by requesting a ssh session (secure shell) into your node that is located at the Internet Address (IP) of 113.113.113.113 using our SSH private key called my-ssh-pem-file.
Use your own ip address and ssh key pair here.
Welcome to Ubuntu 22.04.2 LTS (GNU/Linux 5.19.0-1025-aws x86_64)
* Documentation: https://help.ubuntu.com
* Management: https://landscape.canonical.com
* Support: https://ubuntu.com/advantage
System information as of Sat Jul 8 12:43:58 UTC 2023
System load: 10.0 Processes: 144
Usage of /: 4.9% of 77.35GB Users logged in: 1
Memory usage: 7% IPv4 address for eth0: 172.31.25.243
Swap usage: 0%
* Ubuntu Pro delivers the most comprehensive open source security and
compliance features.
https://ubuntu.com/aws/pro
Expanded Security Maintenance for Applications is not enabled.
0 updates can be applied immediately.
Enable ESM Apps to receive additional future security updates. See https://ubuntu.com/esm or run: sudo pro status
Last login: Sat Jul 8 12:29:17 2023 from 73.138.237.214
nodeadmin@Constellation-Node:~$
Start Configurator
Start the configurator module.
sudo nodectl configure
Since we are using sudo, we will be challenged for our nodeadmin user password.
[sudo] password for nodeadmin:
Advanced Mode
Until we are more comfortable with the configurator and all the particular settings of the configurator, we should not use advanced mode. We will choose no here 👇 ( enter enter to accept the default value or n then enter )
= CONSTELLATION NETWORK HYPERGRAPH =
= NODECTL =
= CONFIGURATION TOOL =
========================================
Code Name: Princess Warrior
Welcome to the nodectl configuration tool.
This feature of nodectl will help you initialize a new configuration or update/edit an existing configuration file.
nodectl will attempt to migrate/integrate your configurations changes in order to ensure a smooth transition and operations of your node via nodectl.
Detailed Mode: will walk you through all steps/questions; with detailed explanations of each element of the configuration.
Advanced Mode: will be non-verbose, with no walk through explanations, only necessary questions.
The configuration tool does only a limited amount of data type or value verification. After the configuration tool creates a new configuration or edits an existing configuration, it will attempt to verify the end resulting configuration.
You can also choose the -a option at the command line to enter advanced mode directly.
Continue in advanced mode? [n]: n
Main Menu
Our goal in this procedure (documentation) is to change profiles, so we want to create a new profile and remove the old, we can do this in one step by choosing n for new here. You will not hit enter, only the n key.
= MAIN MENU =
========================================
N)ew Configuration
E)dit Existing Configuration
Q)uit
KEY PRESS an option
Backup
Before continuing, nodectl will backup your existing configuration file cn-config.yaml and offer you information on where it is located.
By default your configuration will use the /var/tessellation/backups directory. This is where you will find copy of your configuration file with the current system date and time (UTC) appended to the file name. nodectl can now make changes with the confidence that a backup of what was there previous is available if needed.
You can review the information on the screen and press any key to continue.
Configuration Type
The next screen presented will offer information about predefined or custom profiles.
We will choose p for predefined.
= CONFIGURATION TYPE =
========================================
P)redefined Configuration
M)anual Configuration
R)eturn Main Menu
Q)uit
KEY PRESS an option
Passphrase Options
As we begin the creation of a new profile (changing our profile), nodectl will ask if you want to keep your passphrase visible in the configuration. It will also offer you pros and cons, you can make your determination here.
Recommended
Since the security addition is minor for hiding your passphrase in the configuration, it is recommended to choose y here.
Also, the auto restart and upgrade feature will not work unless the passphrase is visible in the configuration.
We can choose y and enter here.
Configuration Options
We can now choose the predefined configuration of our choice. In this example we will choose IntegrationNet. By pressing 2.
= OPTIONS MENU =
========================================
1) Constellation MainNet
2) Constellation IntegrationNet
3) Constellation TestNet
R) Return to Main Menu
Q) Quit
Security Details
Since version 2 of nodectl, you are now able to define a p12 per profile. This will allow you to use a different p12 file independent of the profile on a single node.
In most situations you will want to use the same p12 file for all profiles.
We will choose y and enter here.
Global Passphrase
Since we are changing our profile verses creating a brand new profile from scratch. nodectl will identify that there was a p12 section already filled out from your old configuration. nodectl will ask if you would like to preserve the settings.
We will choose y and enter here.
Alternative
You can choose n if you want to change or provide new p12 information.
New Profile Build
nodectl will start the process of building your new profile.
warning
nodectl will validate your configuration and offer information about possible issues, or validate successfully. Regardless, nodectl will continue the process of building out your profile. If you have errors, unexpected results will ensue.
Create Service file [intnet-l1] ............... running
Create Service file ........................... complete
Create Service file ........................... complete
Review
We will be offered the option to review the newly created configuration. You may choose y to page through the results or n to skip this optional step.
Old Profiles
warning
You may be presented with a CONFIGURATION FILE DID NOT VALIDATE message.
This can be safely ignored. nodectl will correct the issue prior to completing the new configuration build.
nodectl will attempt to clean up old profiles that are not found in the configuration cn-config.yaml file.
In the event there are not old profiles that need to cleaned up, you will not see this message.
If presented to us, we can say y and enter here.
Abandoned [dag-l1] profile.................. found
It is recommended to clean up old profiles to:
- Avoid conflicts
- Avoid undesired node behavior
- Free up disk
Remove old profiles? [y]: y
If you are making a change to a profile; however, using the same profile name, nodectl will check for abandoned snapshots and request that you remove them. If is highly recommended to remove irrelevant snapshots! If you are not overwriting an existing profile, you will not see this message.
If presented with this message, we can say y and enter here.
profile: intnet-l0
This may cause unexpected errors and conflicts, nodectl will remove snapshot contents from this directory
Remove snapshot contents? [y]: y
Exit configurator
Finally, we will be returned to the main menu.
We will choose q to exit nodectl.
= MAIN MENU =
========================================
N)ew Configuration
E)dit Existing Configuration
Q)uit
KEY PRESS an option
nodeadmin@Constellation-Node:~$