Cloudmos is an app that let's you deploy any docker container on the Akash Network in a few clicks... đź›
Every services are nodejs applications written in typescript. They are deployed using docker. Both databases are PostgreSQL deployed on GCP.
Website to deploy on Akash. It is using the Next.js framework. The data shown in the website comes from a combination of our API and akash nodes (REST).
Url: deploy.cloudmos.io
Directory: deploy-web
Used in the deploy website to proxy requests to providers. Needed since it's not possible to use the cert authentication system from the browser.
This is the equivalent of the Proxy used by the akash console.
Directory: provider-proxy
Provides data to the deploy website. The data is fetched from our Indexer database + coingecko for market data. This api also provide the endpoint for the Web3 Index integration.
Url: api.cloudmos.io
Directory: api
Fetch the latest blocks from RPC nodes. Saves the blocks & stats to our Indexer Database. For details on how the indexer work see the Indexer README
Directory: indexer
Small landing page with button to "Launch App".
Url: cloudmos.io
Directory: landing
Directory containing public config file that are fetch by the deploy tool. This is to allow modifying some configurations on the spot without the need to redeploy the web interface.
Directory: config
- Sentry.io is integrated into all our services and allows us to catch js exceptions in the frontend as well as backend.
- HealthChecks.io is used to monitor the execution of our Scheduled Tasks. If a task is failing we get an email + alert in discord.
- Cronitor is used to monitor uptime. If our website or apis goes offline we get an email + alert in discord.
- Grafana dashboards allows us to see usage stats and syncing status. We can monitor block syncing and scheduled task there.
- Status Endpoints
All our backend services have/statusendpoints built into them allowing us to monitor health and view usage stats. Those endpoints are use by the other monitoring tools.
Indexing akash from block #1 take a long time so it is recommended to start from an existing database backup instead.
cloudmos-akash-20230611.sql (18.88Gb)
First create a postgresql database and then restore from the backup using pg_restore.
pg_restore --host "localhost" --port "5432" --username "postgres" --password "password" --dbname "cloudmos-akash" --verbose "/path/to/cloudmos-akash-20230611.sql"
Once your database is ready, follow the instructions in the README of the project you want to run.
The database schemas is defined using sequelize-typescript in /shared/dbSchemas/. Models are separated into the following folders:
- base - Tables which are cosmos generic and are used for every chains
- akash - Tables which are akash specific (they are not created when initializing a database for another chain)
- user - Tables which are user specific. Contains tables for user settings and templates
| Column | Type | Note |
|---|---|---|
| height | integer | |
| datetime | timestamp | |
| hash | varchar | |
| proposer | varchar | |
| dayId | uuid | See Day |
| txCount | integer | |
| isProcessed | boolean | false when inserted into the database and then set to true once the indexers have processed every messages in the block. |
| totalTxCount | bigint | Global tx count as of this height (for historical tx count graphs). |
| totalUAktSpent | double | Cummulative uakt spent on deployments as of this block. |
| activeLeaseCount | integer | Currently active lease count as of this block. Graph |
| totalLeaseCount | integer | Cummulative lease count as of this block. Graph |
| activeCPU | integer | Currently leased CPU as of this block. Graph |
| activeMemory | bigint | Currently leased Memory as of this block. Graph |
| activeEphemeralStorage | bigint | Currently leased Ephemeral Storage as of this block. Graph |
| activePersistentStorage | bigint | Currently leased Persistent Storage as of this block. Graph |
| activeProviderCount | integer | Provider count as of this block. This only consider on-chain data and does not include uptime checks. |
| Column | Type | Note |
|---|---|---|
| id | uuid | |
| hash | varchar | |
| height | integer | |
| msgCount | integer | |
| multisigThreshold | integer | |
| gasUsed | integer | |
| gasWanted | integer | |
| fee | bigint | |
| memo | text | |
| isProcessed | boolean | false when inserted into the database and then set to true once the indexers have processed every messages in the transaction. |
| hasProcessingError | boolean | Indicates if the tx was a success or failed |
| log | text | Contains the error message if the tx failed |
| Column | Type | Note |
|---|---|---|
| id | uuid | |
| txId | uuid | See Transaction |
| height | integer | |
| type | varchar | ex: /cosmos.bank.v1beta1.MsgSend |
| typeCategory | varchar | First part of the message part. ex: cosmos or akash |
| index | integer | |
| indexInBlock | integer | |
| isProcessed | boolean | false when inserted into the database and then set to true once the indexers have processed the message. |
| isNotificationProcessed | boolean | false when inserted into the database and then set to true once it has been checked for existing alerts. (BlockSpy specific) |
| amount | bigint | Amount of the transfer if token were transferred. ex: MsgSend or MsgDelegate |
| data | bytes | Protobuf encoded data of the message |
| relatedDeploymentId | uuid | If the message is deployment related (ex: MsgCloseLease) this will be set to the related deployment. See Deployment |
Keeps track of which addresses are involved in which txs (even if they are not the signer).
| Column | Type | Note |
|---|---|---|
| id | number | |
| transactionId | uuid | See Transaction |
| messageId | uuid | See Message |
| address | varchar | |
| type | varchar | Signer/Sender/Receiver |
Created for each days (UTC based), simplifies querying for daily stats.
| Column | Type | Note |
|---|---|---|
| id | uuid | |
| date | timestamp | |
| aktPrice | double | See the "Sync Price History" task in Scheduled Tasks. |
| firstBlockHeight | integer | First block of the day. |
| lastBlockHeight | integer | Last block of the day. null if the day has not ended. |
| lastBlockHeightYet | integer | Last block of the day as of now. |
| Column | Type | Note |
|---|---|---|
| id | uuid | |
| operatorAddress | varchar | |
| accountAddress | varchar | |
| hexAddress | varchar | |
| createdMsgId | uuid | Message which created the validator (MsgCreateValidator). See Message |
| moniker | varchar | |
| identity | varchar | |
| website | varchar | |
| description | text | |
| securityContact | varchar | |
| rate | double | |
| double | maxRate | |
| maxChangeRate | double | |
| minSelfDelegation | bigint | |
| keybaseUsername | varchar | |
| keybaseAvatarUrl | varchar |
| Column | Type | Note |
|---|---|---|
| id | uuid | |
| owner | varchar | Address of the wallet that owns this deployment |
| dseq | varchar | |
| createdHeight | integer | Height of the MsgCreateDeployment message |
| balance | double | Remaining balance based on deposits and MsgWithdrawLease |
| deposit | bigint | Deposited amount based on MsgCreateDeployment and MsgDepositDeployment |
| lastWithdrawHeight | integer | Last height where an account settlement occured. This happens on create, withdraw and close. |
| withdrawnAmount | double | Withdrawn amount as of now. Updated on account settlement (create,withdraw,close). |
| closedHeight | integer | Height the deployment got closed on-chain. Can happen from MsgCloseDeployment or as a side-effect of having no active leases remaining. |
| Column | Type | Note |
|---|---|---|
| id | uuid | |
| deploymentId | uuid | See Deployment |
| owner | varchar | Address of the wallet that owns this deployment group. |
| dseq | varchar | |
| gseq | integer |
| Column | Type | Note |
|---|---|---|
| id | integer | |
| deploymentGroupId | uuid | See DeploymentGroup |
| cpuUnits | integer | Thousandth of CPU |
| memoryQuantity | bigint | Memory in bytes |
| ephemeralStorageQuantity | bigint | Ephemeral Storage in bytes |
| persistentStorageQuantity | bigint | Persistent Storage in bytes |
| count | integer | |
| price | double |
| Column | Type | Note |
|---|---|---|
| id | uuid | |
| deploymentId | uuid | See Deployment |
| deploymentGroupId | uuid | See DeploymentGroup |
| owner | varchar | Address of the wallet that owns this deployment group. |
| dseq | varchar | |
| oseq | integer | |
| gseq | integer | |
| providerAddress | varchar | |
| createdHeight | integer | Height of the lease creation. Happens when a bid is accepted with MsgCreateLease. |
| closedHeight | integer | Height at which the lease is closed on-chain. Happens from MsgCloseLease, MsgCloseHeight or if the deployment become overdrawn during an account settlement. |
| predictedClosedHeight | bigint | Height at which the lease should theoritically expire. This is calculated based on the balance and price. It will usually not match the closedHeight since leases can be closed early (MsgCloseLease & MsgCloseBid) or closed late since the closing wont happen until the provider does a MsgWithdrawLease |
| price | double | Lease price as uakt/block |
| withdrawnAmount | double | Withdrawn amount as of now for this lease. Updated on account settlement (create,withdraw,close). |
| cpuUnits | integer | Thousandth of CPU |
| memoryQuantity | bigint | Memory in bytes |
| ephemeralStorageQuantity | bigint | Ephemeral Storage in bytes |
| persistentStorageQuantity | bigint | Persistent Storage in bytes |
| Column | Type | Note |
|---|---|---|
| id | integer | |
| owner | varchar | Deployment's wallet address |
| dseq | varchar | |
| gseq | integer | |
| oseq | integer | |
| provider | varchar | Provider's wallet address |
| price | double | Price in uakt/block |
| createdHeight | integer | Height of the MsgCreateBid |
| Column | Type | Note |
|---|---|---|
| owner | varchar | Address of the wallet that owns this provider |
| hostUri | varchar | ex: https://provider.europlots.com:8443 |
| createdHeight | integer | Height at which the provider is created on-chain. (MsgCreateProvider) |
| deletedHeight | integer | Height at which the provider is deleted on-chain. (MsgDeleteProvider) |
| varchar | ||
| website | varchar | |
| isOnline | boolean | Indicates if the latest uptime check was successful |
| lastCheckDate | timestamp | Date & Time of the latest uptime check |
| error | text | null if the latest uptime check was successful, otherwise this wil contain the error message. |
| deploymentCount | integer | |
| leaseCount | integer | |
| activeCPU | bigint | Thousandth of CPU |
| activeMemory | bigint | Memory in bytes |
| activeStorage | bigint | Storage in bytes |
| pendingCPU | bigint | Thousandth of CPU |
| pendingMemory | bigint | Memory in bytes |
| pendingStorage | bigint | Storage in bytes |
| availableCPU | bigint | Thousandth of CPU |
| availableMemory | bigint | Memory in bytes |
| availableStorage | bigint | Storage in bytes |
| akashVersion | varchar | |
| cosmosSdkVersion | varchar | |
| ip | varchar | IP obtained by resolving DNS for the hostUri |
| ipRegion | varchar | |
| ipCountry | varchar | |
| ipLat | varchar | |
| ipLon | varchar | |
| ipRegionCode | varchar | |
| ipCountryCode | varchar |
| Column | Type | Note |
|---|---|---|
| id | integer | |
| provider | varchar | Provider's wallet address |
| key | varchar | |
| value | varchar |
Store audited attributes based on MsgSignProviderAttributes & MsgDeleteProviderAttributes.
| Column | Type | Note |
|---|---|---|
| id | integer | |
| provider | varchar | Provider's wallet address |
| auditor | varchar | Auditor's wallet address |
| key | varchar | |
| value | varchar |
Similar to stats on the Provider, but a new row is inserted for every uptime checks. This allows to graph the changes in resources over time as well as calculate an uptime percentage over a period.
| Column | Type | Note |
|---|---|---|
| id | uuid | |
| owner | varchar | Address of the wallet that owns this provider |
| isOnline | boolean | Indicates if this uptime check was successful |
| checkDate | timestamp | Date & Time of this uptime check |
| error | text | null if the uptime check was successful, otherwise this wil contain the error message. |
| deploymentCount | integer | |
| leaseCount | integer | |
| activeCPU | bigint | Thousandth of CPU |
| activeMemory | bigint | Memory in bytes |
| activeStorage | bigint | Storage in bytes |
| pendingCPU | bigint | Thousandth of CPU |
| pendingMemory | bigint | Memory in bytes |
| pendingStorage | bigint | Storage in bytes |
| availableCPU | bigint | Thousandth of CPU |
| availableMemory | bigint | Memory in bytes |
| availableStorage | bigint | Storage in bytes |
| Column | Type | Note |
|---|---|---|
| id | uuid | |
| userId | uuid | See User |
| copiedFromId | uuid | If the template was created by using the copy feature, this will contain the id of the original template. |
| title | varchar | |
| description | text | |
| isPublic | boolean | |
| cpu | bigint | |
| ram | bigint | |
| storage | bigint | |
| sdl | text | |
| createdOn | timestamp |
Created when a user "favorite" a template
| Column | Type | Note |
|---|---|---|
| id | uuid | |
| userId | uuid | See User |
| templateId | uuid | See Template |
| addedDate | datetime |
| Column | Type | Note |
|---|---|---|
| id | uuid | |
| userId | varchar | User ID given by Auth0 this is the field other tables reference to. |
| username | varchar | |
| varchar | ||
| emailVerified | boolean | |
| stripeCustomerId | varchar | Created once the user visits the checkout page |
| bio | text | |
| subscribedToNewsletter | boolean | |
| youtubeUsername | varchar | |
| twitterUsername | varchar | |
| githubUsername | varchar |