This repository contains all components related to mining on the chutes.ai permissionless, serverless, AI-centric compute platform.
We've tried to automate the bulk of the process via ansible, helm/kubernetes, so while it may seem like a lot, it should be fairly easy to get started.
The goal of mining on chutes is to provide as much compute as possible, optimizing for cold start times (running new applications or applications that have been preempted). Everything is automated with kubernetes, and coordinated by the gepetto.py script to optimize for cost efficiency and maximize your share of compute.
Incentives are based on total compute time (including bounties give from being first to provide inference on code app).
You should probably run a wide variety of GPUs, from very cheap (a10, a5000, t4, etc.) to very powerful (8x h100 nodes).
Never register more than one UID, since it will just reduce your total compute time and you'll compete with yourself pointlessly. Just add capacity to one miner.
Incentives/weights are calculated from 7 day sum of compute, so be patient when you start mining. We want high quality, stable miners in it for the long haul!
While not strictly necessary, we highly encourage all miners to use our provided ansible scripts to provision servers. There are many nuances and requirements that are quite difficult to setup manually.
More information on using the ansible scripts in subsequent sections.
Wireguard is a fast, secure VPN service that is created by ansible provisioning, which allows your nodes to communicate when they are not all on the same internal network.
It is often the case that you'll want CPU instances on one provider (AWS, Google, etc.), and GPU instances on another (Latitude, Massed Compute, etc.), and you may have several providers for each due to inventory.
By installing Wireguard, your kubernetes cluster can span any number of providers without issue.
this is installed and configured automatically by ansible scripts
The entirety of the chutes miner must run within a kubernetes While not strictly necessary, we recommend using microk8s (which is all handled automatically from the ansible scripts). If you choose to not use microk8s, you must also modify or not use the provided ansible scripts.
this is installed and configured automatically by ansible scripts
There are many components and moving parts to the system, so before you do anything, please familiarize yourself with each!
We make heavy use of SQLAlchemy/postgres throughout chutes. All servers, GPUs, deployments, etc., are tracked in postgresql which is deployed as a statefulset with a persistent volume claim within your kubernetes cluster.
this is installed and configured automatically when deploying via helm charts
Redis is primarily used for it's pubsub functionality within the miner. Events (new chute added to validator, GPU added to the system, chute removed, etc.) trigger pubsub messages within redis, which trigger the various event handlers in code.
this is installed and configured automatically when deploying via helm charts
Chutes uses a custom c/CUDA library for validating graphics cards: https://github.com/rayonlabs/graval
The TL;DR is that it uses matrix multiplications seeded by device info to verify the authenticity of a GPU, including VRAM capacity tests (95% of total VRAM must be available for matrix multiplications). All traffic sent to instances on chutes network are encrypted with keys that can only be decrypted by the GPU advertised.
When you add a new node to your kubernetes cluster, each GPU on the server must be verified with the GraVal package, so a bootstrap server is deployed to accomplish this (automatically, no need to fret).
Each time a chute starts/gets deployed, it also needs to run GraVal to calculate the decryption key that will be necessary for the GPU(s) the chute is deployed on.
this is done automatically
In order to keep the chute docker images somewhat private (since not all images are public), we employ a registry proxy on each miner that injects authentication via bittensor key signature.
Each docker image appears to kubelet as [validator hotkey ss58].localregistry.chutes.ai:30500/[image username]/[image name]:[image tag]
This subdomain points to 127.0.0.1 so it always loads from the registry service proxy on each GPU server via NodePort routing and local first k8s service traffic policy.
The registry proxy itself is an nginx server that performs an auth subrequest to the miner API. See the nginx configmap: https://github.com/rayonlabs/chutes-miner/blob/main/charts/templates/registry-cm.yaml
The miner API code that injects the signatures is here: https://github.com/rayonlabs/chutes-miner/blob/main/api/registry/router.py
Nginx then proxies the request upstream back to the validator in question (based on the hotkey as part of the subdomain), which validates the signatures and replaces those headers with basic auth that can be used with our self-hosted registry: https://github.com/rayonlabs/chutes-api/blob/main/api/registry/router.py
this is installed and configured automatically when deploying via helm charts
In order to prevent some amount of abuse of the platform, chutes are limited to HTTPS traffic, and only through a squid proxy. The squid proxy server does not currently cache, rather it's used to filter the list of upstream domains the chutes are allowed to connect to, e.g. huggingface, S3, etc.
The list of allowed domains will change over time, but can be found in the configmap within the charts directory here
this is installed and configured automatically when deploying via helm charts
Each miner runs an API service, which does a variety of things including:
- server/inventory management
- websocket connection to the validator API
- docker image registry authentication
this is installed and configured automatically when deploying via helm charts
Gepetto is the key component responsible for all chute (aka app) management. Among other things, it is responsible for actually provisioning chutes, scaling up/down chutes, attempting to claim bounties, etc.
This is the main thing to optimize as a miner!
The first thing you'll want to do is provision your servers/kubernetes.
ALL servers must be bare metal/VM, meaning it will not work on Runpod, Vast, etc., and we do not currently support shared or dynamic IPs - the IPs must be unique, static, and provide a 1:1 port mapping.
It is very important to have as much RAM (or very close to it) per GPU as VRAM. This means, for example, if you are using a server with 4x a40 GPUs (48GB VRAM), the server must have >= 48 * 4 = 192 GB of RAM! If you do not have at least as much RAM per GPU as VRAM, deployments are likely to fail and your servers will not be properly utilized.
Some providers mount the primary storage in inconvient ways, e.g. latitude.sh when using raid 1 mounts the volume on /home, hyperstack mounts under /ephemeral, etc. Before running the ansible scripts, be sure to login to your servers and check how the storage is allocated. If you want storage space for huggingface cache, images, etc., you'll want to be sure as much as possible is allocated under /var/snap.
You can do this with a simple bind mount, e.g. if the main storage is under /home, run:
rsync -azv /var/snap/ /home/snap/
echo '/home/snap /var/snap none bind 0 0' >> /etc/fstab
mount -aBefore starting, you must either disable all layers of firewalls (if you like to live dangerously), or enable the following:
- allow all traffic (all ports, all protos inc. UDP) between all nodes in your inventory
- allow the kubernetes ephemeral port range on all of your GPU nodes, since the ports for chute deployments will be random, in that range, and need public accessibility - the default port range is 30000-32767
- allow access to the various nodePort values in your API from whatever machine you are managing/running chutes-miner add-node/etc., or just make it public (particularly import is the API node port, which defaults to 32000)
The primary CPU node, which the other nodes connect to as the wireguard primary, needs to have IP forwarding enabled -- if your node is in GCP, for example, there's a checkbox you need to enable for IP forwarding.
You'll need one non-GPU server (8 cores, 64gb ram minimum) responsible for running postgres, redis, gepetto, and API components (not chutes), and ALL of the GPU servers 😄 (just kidding of course, you can use as many or as few as you wish)
The list of supported GPUs can be found here
Head over to the ansible documentation for steps on setting up your bare metal instances. Be sure to update inventory.yml
The easiest way to interact with kubernetes would be from within the primary node, but you can alternatively set it up on your local machine or other server. To do so:
- install kubectl
- copy the the kubernetes configuration from the CPU primary via
microk8s configand put it on your workstation at~/.kube/config - replace the IP address of the cluster with the public IP address of the primary node
- since the IP will not match the cert, you will need to specify
--insecure-skip-tls-verifywhen running any kubectl commands from this server (not necessary when done on primary node)
If you plan to use the primary node, you should alias kubectl and helm:
echo 'alias kubectl="microk8s kubectl"' >> .bashrc
echo 'alias helm="microk8s helm"' >> .bashrcYou'll need to setup a few things manually:
- Create a docker hub login to avoid getting rate-limited on pulling public images (you may not need this at all, but it can't hurt):
- Head over to https://hub.docker.com/ and sign up, generate a new personal access token for public read-only access, then create the secret:
kubectl create secret docker-registry regcred --docker-server=docker.io --docker-username=[repalce with your username] --docker-password=[replace with your access token] --docker-email=[replace with your email]
- Create the miner credentials
- You'll need to find the ss58Address and secretSeed from the hotkey file you'll be using for mining, e.g.
cat ~/.bittensor/wallets/default/hotkeys/hotkey
- You'll need to find the ss58Address and secretSeed from the hotkey file you'll be using for mining, e.g.
kubectl create secret generic miner-credentials \
--from-literal=ss58=[replace with ss58Address value] \
--from-literal=seed=[replace with secretSeed value, removing '0x' prefix] \
-n chutes
Here's an example using a throwaway key. Suppose you created a hotkey as such:
$ btcli wallet new_hotkey --wallet.name offline --wallet.hotkey test --wallet.path ~/.bittensor/wallets
...Print out the content of that hotkey, and optionally pipe to jq to pretty-print:
$ cat ~/.bittensor/wallets/offline/hotkeys/test | jq .
{
"accountId": "0x5a30cd5517328838f69ed48531894d94e9f231dff241e1561260a8522a167731",
"publicKey": "0x5a30cd5517328838f69ed48531894d94e9f231dff241e1561260a8522a167731",
"privateKey": "0x69de0e5d7e66902d5b9da02091bb130aedf49d6c53a2fe67eeb914520e0ea70aa2176663f7b30c93d8826c702e9b22c35ab1a99afbdc02c35618c97e00edab3a",
"secretPhrase": "inform sell fitness extra kitten unit hood glass window law spider desk",
"secretSeed": "0xe031170f32b4cda05df2f3cf6bc8d76827b683bbce23d9fa960c0b3fc21641b8",
"ss58Address": "5E6xfU3oNU7y1a7pQwoc31fmUjwBZ2gKcNCw8EXsdtCQieUQ"
}To create the secret from this key, the command would be:
kubectl create secret generic miner-credentials \
--from-literal=ss58=5E6xfU3oNU7y1a7pQwoc31fmUjwBZ2gKcNCw8EXsdtCQieUQ \
--from-literal=seed=e031170f32b4cda05df2f3cf6bc8d76827b683bbce23d9fa960c0b3fc21641b8 \
-n chutesBe sure to thoroughly examine values and update according to your particular environment.
Primary sections to update:
Unlike most subnets, the validators list for chutes must be explicitly configured rather than relying on the metagraph. Due to the extreme complexity and high expense of operating a validator on this subnet, we're hoping most validators will opt to use the child hotkey functionality rather that operating their own validators.
To that end, any validators you wish to support MUST be configured in the top-level validators section:
The default mainnet configuration is:
validators:
defaultRegistry: registry.chutes.ai
defaultApi: https://api.chutes.ai
supported:
- hotkey: 5Dt7HZ7Zpw4DppPxFM7Ke3Cm7sDAWhsZXmM5ZAmE7dSVJbcQ
registry: registry.chutes.ai
api: https://api.chutes.ai
socket: wss://ws.chutes.aiTo enable faster cold-starts, the kubernetes deployments use a hostPath mount for caching huggingface models. The default is set to purge anything over 7 days old, when > 500gb has been consumed:
cache:
max_age_days: 30
max_size_gb: 850
overrides:You can override per-node settings with the overrides block there, e.g.:
cache:
max_age_days: 30
max_size_gb: 850
overrides:
node-0: 5000In this example, the default will be 850GB, and node-0 will have 5TB.
If you have lots and lots of storage space, you may want to increase this or otherwise change defaults.
The defaults should do fairly nicely here, but you may want to tweak the service, namely nodePort, if you want to change ports.
minerApi:
...
service:
nodePort: 32000
...Feel free to adjust redis/postgres/etc. as you wish, but probably not necessary.
Gepetto is the most important component as a miner. It is responsible for selecting chutes to deploy, scale up, scale down, delete, etc. You'll want to thoroughly examine this code and make any changes that you think would gain you more total compute time.
Once you are satisfied with the state of the gepetto.py file, you'll need to create a configmap object in kubernetes that stores your file (from inside the chutes-miner directory, from cloning repo):
kubectl create configmap gepetto-code --from-file=gepetto.py -n chutesAny time you wish to make further changes to gepetto, you need to re-create the configmap:
kubectl create configmap gepetto-code --from-file=gepetto.py -o yaml --dry-run=client | kubectl apply -n chutes -f -You must also restart the gepetto deployment after you make changes, but this will only work AFTER you have completed the rest of the setup guide (no need to run when you initially setup your miner):
kubectl rollout restart deployment/gepetto -n chutes
First, and exactly one time, you'll want to generate passwords for postgres and redis - never run this more than once or things will break!
Execute this from the charts directory:
helm template . --set createPasswords=true -s templates/one-time-passwords.yaml | kubectl apply -n chutes -f -Once the secrets are created, you can run this any time to generate your deployment charts, from within the charts directory:
helm template . -f values.yaml > miner-charts.yamlAny time you change values.yaml, you will want to re-run the template command to get the updated charts!
Then, you will deploy the chutes components with:
kubectl apply -f miner-charts.yaml -n chutesRegister as a miner on subnet 64.
btcli subnet register --netuid 64 --wallet.name [COLDKEY] --wallet.hotkey [HOTKEY]You should not announce an axon here! All communications are done via client-side initialized socket.io connections so public axons serve no purpose and are just a security risk.
The last step in enabling a GPU node in your miner is to use the add-node command in the chutes-miner CLI. This calls the miner API, triggers spinning up graval validation services, etc. This must be run exactly once for each GPU node in order for them to be usable by your miner.
Make sure you install chutes-miner-cli package (you can do this on the CPU node, your laptop, wherever):
pip install chutes-miner-cliRun this for each GPU node in your inventory:
chutes-miner add-node \
--name [SERVER NAME FROM inventory.yaml] \
--validator [VALIDATOR HOTKEY] \
--hourly-cost [HOURLY COST] \
--gpu-short-ref [GPU SHORT IDENTIFIER] \
--hotkey [~/.bittensor/wallets/[COLDKEY]/hotkeys/[HOTKEY] \
--miner-api http://[MINER API SERVER IP]:[MINER API PORT]--namehere corresponds to the short name in your ansible inventory.yaml file, it is not the entire FQDN.--validatoris the hotkey ss58 address of the validator that this server will be allocated to--hourly-costis how much you are paying hourly for this server; part of the optimization strategy in gepetto is to minimize cost when selecting servers to deploy chutes on--gpu-short-refis a short identifier string for the type of GPU on the server, e.g.a6000,l40s,h100_sxm, etc. The list of supported GPUs can be found here--hotkeyis the path to the hotkey file you registered with, used to sign requests to be able to manage inventory on your system via the miner API--miner-apiis the base URL to your miner API service, which will be http://[non-GPU node IP]:[minerAPI port, default 32000], i.e. find the public/external IP address of your CPU-only node, and whatever port you configured for the API service (which is 32000 if you didn't change the default).
You can add additional GPU nodes at any time by simply updating inventory.yaml and rerunning the site.yaml and join-cluster.yaml playbooks: ansible readme
To expand your miner's inventory, you should bootstrap them with the ansible scripts, specifically the site and join-cluster bits. Info for the ansible portions here
Then, run the chutes-miner add-node ... command above.
