Bare Metal with Kubernetes (K3s) + AMD SEV SNP
Your server, your cloud, your data...
Initial setup steps
First of all, let's move to the proper directory:
From here, we can start running all the scripts, step by step, using the first two chars in the filename as a numerical order, starting from the smallest and going in ascending order.
Step by step installation
This step will download and install a custom version of the Linux kernel, patched by AMD engineers to support SNP correctly.
Remember to reboot and verify that your system is then running kernel version 6.8.0-rc5-next-20240221-snp-host-cc2568386.
Reboot done? good! If you haven't enable AMD SEV SNP in your BIOS now is a good time to do so. Now you can proceed with:
This step will install a few utility tools like helm and k9s to interact with Kubernetes in amore efficient way.
This will install a small utility called snphost that can be used effectively by running:
anywhere in your system to run all the necessary AMD SEV SNP checks. You will get a list of checks that should all report PASS .
If that's not the case, you probably forgot to change/enable some of the needed settings in BIOS.
To proceed, let's start by installing Kubernetes with k3s using the following step:
This will just download and install k3s and start it.
After Kubernetes settles (you can check by connecting via k9s or kubectl) you can proceed by running next step:
which will download our custom components and set k3s up to use them.
Creating a payer.json Solana Account
In this phase of the setup you're going to enter a temporary environment and create the Solana Account used by your Oracle. If you don't save the output when suggested to, once you'll leave this temporary container it will be really hard (if not impossible) to retrieve the content and thus the account you created. So please take time to read carefully instructions as you go through each step.
Let's start with:
This step will drop you in a temporary container that will have all the necessary tools to run the following step:
This step will create a new account on the Solana network that will be used by your Oracle and save it in the data directory, in the respective devnet and mainnet files.
By default this script will crate a devnet account, so you want to create one for mainnet you have to call by adding mainnet at the end as shown above.
Once done with the steps above, you can leave the container by typing exit and will be dropped back to the docker installation directory.
Create a request to register your Oracle and Guardian to Switchboard queue
Now that you have a Solana account that can be used by your Oracle, you can send a request to be allowed to cooperate to the Switchboard network by contributing to tasks on a specific queue.
To do so, we have another special container that will make your life easy. To enter it just type:
To send your request simply run:
Save the output of the command above and follow the link provided to send your request. Our operators will receive your request and provide you permission to be included in the queue as soon as possible.
Once done with the steps above, you can leave the container by typing exit and will be dropped back to the docker installation directory.
Save values from the output in the file dedicated to devnet or mainnet inside the cfg directory, based on your current setup.
[RECOMMENDED] Enrolling Your Oracle in a Node Consensus Network (NCN)
After your Oracle has been granted permissions to participate in the Switchboard network, you can optionally enroll it in a Node Consensus Network (NCN) to participate in the restaking ecosystem. This allows your Oracle to earn additional rewards while contributing to network security.
To enroll your Oracle in an NCN, run the following command from the same temporary container you used for the previous steps:
This script will:
Check if you already have an NCN operator account or create a new one if needed
Link your Switchboard Oracle to your NCN operator
Initialize and prepare your operator for vault interactions
Guide you through the enrollment process with clear instructions
What to Expect During Enrollment
The script will display important information about your enrollment, including:
Solana cluster (devnet or mainnet)
NCN address
Vault address
NCN operator address
Oracle operator address
Important: You must save this information when prompted. The script will display several notices with boxes around them - these contain critical information you'll need.
Two-Phase Enrollment Process
The NCN enrollment is a two-phase process:
Initial Setup: The script will execute the first set of transactions to link your Oracle to the NCN operator and initialize vault permissions.
Completion Phase: After Switchboard confirms your enrollment on their side, you'll need to return to the temporary container and run the final command displayed by the script to complete the process.
Different Authority Scenarios
If your Oracle keypair authority is different from your NCN operator admin, the script will detect this and provide you with specific instructions for completing the enrollment using separate keypairs.
After completing the enrollment process, your Oracle will be fully integrated with the NCN ecosystem, allowing you to participate in restaking and earn additional rewards.
Remember to exit the temporary container when you're done by typing exit.
Install Kubernetes (with k3s) and all needed apps
For the following steps, you should be able to run them in order with no particular change. Just give each step 30-60 seconds to settle before proceeding to the next one:
The first the TLS certificate manager needed to create the HTTPs certificate that runs the reverse proxy in front of your gateway component.
Next you should install our Ingress toolset based on nginx:
This will install nginx ingress and enable it.
[RECOMMENDED] Enable watchtower auto-update mechanism
To make maintenance and regular updates easier for our partners we propose a mechanism based on watchtower.
This software will monitor our repos automatically for you and pull and deploy newer versions of our Oracle automatically without any intervention on your side.
If you want to enable this feature, please run:
You can always disable it by removing it via helm.
If you don't use watchtower, please note that old Oracles that are not up-to-date will be excluded from running tasks in our queues.
[OPTIONAL] Enable metrics reporting and monitoring
While the following step is optional, we recommend running it as this will send statistics about your Oracle to our systems so that we can keep an eye on anomalies or outliers behaviors and warn you promptly if we detect any and keep our network safe:
[OPTIONAL] Enable logs reporting for debugging purpose during support reqs
This step will enable sending all logs from your deployment to our central loggging aggregation system.
To do so we'll have to provide you a usernameand password to use in the command below.
This is a set of ephemeral credentials that will only work for the time need for the support request and will be deactivated afterwards.
After getting credentials from us please run:
remember to run the following command to clean up the logs forward installation after the support phase is completed:
and verify that the installation is gone.
[OPTIONAL] Secrets management via Infisical
Next is another optional step:
[OPTIONAL] TLS certificate creation test
Another optional step:
This script will create an Ingress that will test your Kubernetes installation, DNS setup and the entire flow.
To verify that it's working, run the script above, give it 3-5 minutes and then visit the DNS record you decided to use for your system.
When done, please run:
to clean up the artifacts that the test created.
Finally start your Oracle!
If everything went well, it's now just a matter of running:
So that the last step will install our Oracle code and run it in your Kubernetes cluster.
From this point onward, you can use the usual Kubernetes tools that you use to work with your cluster.
Troubleshooting
Oracle not starting after reboot
Sometimes after a serve reboot, your Oracle containers may refuse to start and give back an error saying something like:
In this case, just run the step:
and delete the Kubernetes PODs so that they will be recreated correctly.
Last updated