Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sashaafm/nomad
Elixir/Phoenix Cloud SDK and Deployment Tool
https://github.com/sashaafm/nomad
Last synced: 8 days ago
JSON representation
Elixir/Phoenix Cloud SDK and Deployment Tool
- Host: GitHub
- URL: https://github.com/sashaafm/nomad
- Owner: sashaafm
- Created: 2016-03-01T16:45:42.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-03-04T16:39:46.000Z (over 4 years ago)
- Last Synced: 2024-10-18T13:00:14.450Z (21 days ago)
- Language: Elixir
- Homepage:
- Size: 473 KB
- Stars: 84
- Watchers: 4
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - Create cloud portable Elixir and Phoenix apps. Write once, use everywhere! (Cloud Infrastructure and Management)
- fucking-awesome-elixir - nomad - Create cloud portable Elixir and Phoenix apps. Write once, use everywhere! (Cloud Infrastructure and Management)
- awesome-elixir - nomad - Create cloud portable Elixir and Phoenix apps. Write once, use everywhere. (Cloud Infrastructure and Management)
README
# Nomad
**Create cloud portable Elixir and Phoenix apps. Write once, use everywhere!**
**Regular API service interaction**
Use the same universal API across all cloud providers. Changes are only minimal and at configuration level. **No code has to be changed.**
[**Tutorials can be found here**](http://sashaafm.github.io/nomad/)
## Table of Contents
- [What is the Nomad Project?](#what_is)
- [What are the use cases for Nomad?](#use_cases)
- [How is it done?](#how_is_it_done)
- [Roadmap](#roadmap)
- [SDK](#sdk)
- [Mix Tasks/Deployment Tool](#mix_tasks)
- [Installation](#installation)
- [Configuration](#configuration)
- [Amazon Web Services](#aws_config)
- [Google Cloud Platform](#gcl_config)
- [API Specification and Usage Examples](#usage_examples)
- [Storage](#storage_examples)
- [SQL](#sql_exmaples)
- [Virtual Machines](#vm_examples)
- [Datastore](#datastore_examples)
- [Mix Tasks](#mix_tasks_examples)
- [Tutorials](#tutorials)
## What is the Nomad Project?
Nomad is an Open-Source API for Elixir that enables developer to use the most popular cloud providers interchangeabily at will without having to change any of their code. Nomad provides generic API's for cloud services (mainly Virtual Machines, Storage, SQL and JSON datastores). These API's offer the most useful features and functionalities that are common across the same kind of service between cloud providers. They are meant to be simple and user friendly. This enables applications to be portable and allows the migration of applications from one provider to the next.
Moreso Nomad offers Mix Tasks for automatic management of cloud resources for your application. Need a SQL database in the Cloud for your application? Create it and automatically configure your app to use the one you just created. Want to host your Phoenix app in the Cloud? Launch a Virtual Machine through Nomad Mix Tasks and let it automatically deploy a production release of your app in said VM.
This project is my subject for my Master's Thesis but once it's delivered it will be a pure Open Source application.
**Disclaimer: Nomad is under heavy development and is prone to changes**
### What are the use cases for Nomad?
The main goal of the Nomad project is to defeat Cloud Vendor Lock-in in the Elixir ecosystem. With the rise in popularity of cloud services Elixir users should not be restricted to one provider and should be able to make the most out of Cloud Computing. Some of the identified use cases are the following (but there are many more):
1. You're using S3 storage for a Phoenix application but a few months later Google has better pricing? Just let Nomad automatically copy your whole S3 bucket to a Google Storage bucket and relaunch the app with Google configurations.
2. Recently got a new userbase in a remote region? Launch a new Virtual Machine with your application in the closest available region.
3. Need a powerful SQL database but you're not really knowledgeable in Cloud related affairs? Just use Nomad's user friendly API and it will get done in a jiffy!
### How is it done?
Nomad takes a lot of inspiration from [Ecto](https://github.com/elixir-lang/ecto) and uses adapters in a similar fashion. First and foremost the needed API functions are identified based on what the cloud providers' APIs have to offer and on what are the most recurring use cases and used functionalities. From this a general Elixir Behaviour is defined. These Behaviours must be implemented by each provider's adapter.
Each adapter will implement the APIs for each cloud service (Virtual Machines, SQL, Storage and Datastore). Upon starting up an application a simple config in the desired environment config is needed - mainly cloud account credentials and a key to identify the chosen provider.
Finally through macros and metaprogramming, the adapters logic will be generated for the Nomad main modules (VirtualMachines, SQL, Storage and Datastore modules).
### Roadmap
#### SDK
- [x] Storage API
- [x] SQL API
- [x] Virtual Machines API
- [ ] Datastore API
- [ ] Friendly Mode and Full Control Mode (return parsed response vs. raw HTTP response)
#### Mix Tasks/Deployment Tool
- [x] Database Listing
- [x] Database Creation
- [x] Database Deletion
- [x] Database Reboot
- [ ] Automatic Deployment
- [ ] Virtual Machine Creation
- [ ] Virtual Machine Reboot
- [ ] Virtual Machine Deletion
- [ ] Storage Creation
- [ ] Storage Deletion
- [ ] Storage Migration
1. Add nomad to your list of dependencies in mix.exs:
def deps do
[{:nomad, "~> 0.6.0"}]
end
or
def deps do
[{:nomad, github: "sashaafm/nomad" }]
end
2. Ensure nomad is started before your application:
def application do
[applications: [:nomad]]
end
### Configuration
#### General
For every cloud provider you will need to add to your desired environment the following:
config :nomad,
cloud_provider:
#### Amazon Web Services
To use Amazon Web Services the following configurations are needed:
config :nomad,
cloud_provider: :aws
Then pass your AWS Access Key ID and AWS Secret Access Key as System variables when launching the application like so:
AWS_ACCESS_KEY_ID= AWS_SECRET_ACCESS_KEY=
#### Google Cloud Platform
To use Google Cloud Platofrm the following configurations are needed:
config :nomad,
cloud_provider: :gcl
config :goth,
json: "config/creds.json" |> Path.expand |> File.read!
Where 'creds.json' is the JSON file with your account credentials that you may download from your Google Cloud Console. Alternatively you may name the file whatever you want as long as you change the config accordingly.
### API Specifications and Usage Examples
#### Storage
**Specification Docs**
[Online Documentation](https://hexdocs.pm/nomad/Nomad.Storage.html) - Docs still under development
**Examples**
1. List available storages
Nomad.Storage.list_storages
#=> ["bucket_1", "bucket_2"]
2. List files inside a storage
Nomad.Storage.list_items "bucket_1"
# => [".gitignore", "/random/archive/Director-free.zip",
"/new_dir/other_dir/some_file.txt", "README.md", "architecture.png",
"examples/examples.desktop", "storage_API"]
3. Create a storage
Nomad.Storage.create_storage "bucket_name", "region_name", "bucket_class"
# => :ok
4. Combine API functions
Nomad.Storage.list_storages |> Enum.map(fn storage -> {storage, Nomad.Storage.get_storage_region(storage)} end)
[{"bucket_1", "EUROPE-WEST1"}, {"bucket_2", "US"}]
#### SQL
**Specification Docs**
[Online Documentation](https://hexdocs.pm/nomad/Nomad.SQL.html) - Docs still under development
**Examples**
#### Virtual Machines
**Under development**
#### Datastorea
**Under development**
### Tutorials
[**Tutorials**](http://sashaafm.github.io/nomad/)