Please note, that this project is deprecated and moved to https://github.com/openware/opendax
Minimal stack for VM deployment.
gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
curl -sSL https://get.rvm.io | bash -s stable
bundle
rake -T
rake service:all
Insert in file /etc/hosts
0.0.0.0 www.app.local
0.0.0.0 monitor.app.local
You can login on www.app.local with the following default users from seeds.yaml
Seeded users:
Email: [email protected], password: 0lDHd9ufs9t@
Email: [email protected], password: Am8icnzEI3d!
All the MicroKube deployment files have their confguration stored in config/app.yml.
Feel free to fill it out with correct values:
| Parameter | Description |
|---|---|
app.name |
Global application name |
app.domain |
Base domain name to be used |
ssl.enabled |
Enable SSL certificate generation |
ssl.email |
Email address to use for SSL generation requests |
images |
Application images tags |
vendor |
Frontend application Git repo URL |
Once you're done with the configuration, render the files using rake render:config. You can easily apply your changes at any time by running this command.
Note: be sure to append all the subdomains based on app.domain to your
/etc/hosts file if you're running MicroKube locally
The MicroKube stack can be brought up using two ways:
- Bootstrap all the components at once using
rake service:all[start] - Start every component one by one using
rake service:*component*[start]
The components included in the stack are:
proxy- Traefik, a robust cloud native edge router/reverse proxy written in Gobackend- Vault, MySQL, Redis and RabbitMQ grouped togethercryptonodes- cryptocurrency nodes such as Geth [Optional]daemons- Peatio daemons and Ranger [Optional]setup- setup hooks for Peatio and Barong to run before the application starts(DB migration etc.)app- Peatio, Barong and the Ambassador API gatewayfrontend- the frontend application located atvendor/frontendtower- the Tower admin panel application located atvendor/tower
For example, to start the backend services, you'll simply need to run rake service:backend[start]
Note: all the components marked as [Optional] need to be installed using
rake service:*component*[start] explicitly
Go ahead and try your deployment on www.your.domain!
Any component from the stack can be easily stopped or restarted using rake service:*component*[stop] and rake service:*component*[restart].
For example, rake service:frontend[stop] would stop the frontend application container and rake service:proxy[restart] would completely restart the reverse proxy container.
Note: Make sure your VM of choice has its firewall rules configured to let in
HTTP and/or HTTPS traffic and your DNS entries are pointing at its external IP.
All the components with external endpoints are accessible by their respective subdomains based on the domain provided in the configuration:
www.base.domain- frontend application and Peatio and Barong APIs mounted on/apipeatio.base.domain- Peatio UI and APIbarong.base.domain- Barong APItower.base.domain- the Tower admin panel applicationmonitor.base.domain- Traefik's dashboard useful for monitoring which components are enabledws.ranger.base.domain- Ranger's WebSocket endpoint [Optional]eth.base.domain- Geth JSON RPC API [Optional]
Fill in the list of vendor to clone in app.yaml
rm compose/vendor.yaml
rake render:config
Review the generated file
source ./bin/set-env.sh
rake vendor:clone
docker-compose -f compose/vendor.yaml up -d
You can easily bring up Microkube from scratch on Google Cloud Platform using Terraform!
To do this, just follow these simple steps:
- Fill
app.ymlwith correct values - Run
rake terraform:apply - Access your VM from the GCP Cloud Console
- Have fun using it!
To destroy the provisioned infrastructure, just run rake terraform:destroy
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/rubykube/microkube/master/bin/install)"