README
¶
n0stack
The n0stack is a simple cloud provider using gRPC.
Description
The n0stack is...
- a cloud provider.
- You can use some features: booting VMs, managing networks and so on (see also n0proto.)
- simple.
- There are shortcode and fewer options.
- using gRPC.
- A unified interface increase reusability.
- able to be used as library and framework.
- You can concentrate to develop your logic by sharing libraries and frameworks for middleware, test, and deployment.
Motivation
Cloud providers have various forms depending on users. This problem has been solved with many options and add-ons (e.g. OpenStack configuration file is very long.) It is difficult to adapt to the application with options, therefore it is necessary to read or rewrite long abstracted code. I think it is better to code it yourself from the beginning.
There are some problems to develop cloud providers from scratch: no libraries, software quality, man-hours, and deployment. The n0stack wants to solve these problems.
Getting started
Prerequisites
- Docker
- docker-compose
- Ubuntu 18.04 LTS
Deploy all in one
- You can start controllers on docker and install agent as follows:
wget https://raw.githubusercontent.com/n0stack/n0stack/master/deploy/docker-compose.yml
docker-compose up -d
docker run -it --rm -v $PWD:/dst n0stack/n0stack cp /usr/local/bin/n0core /dst
./n0core install agent -a "--node-api-endpoint=localhost:20180 --location=////1"
- Download n0cli from Github releases.
- Try use cases.
Documentations
User documentations and specifications is readthedocs.
Golang library documentations is GoDoc.
Components
The final goal of n0stack is to represent the state of all clusters with n0proto.
Implementations such as n0core manipulates the cluster according to the information specified by n0proto.
The implementation of n0proto is left to each developer.
This repository is just a reference implementation.
However, please share actively usable libraries such as n0core/pkg/driver.
n0proto
Protobuf definitions for all of n0stack services.
n0cli
CLI for n0stack API.
n0ui
Web UI for n0stack API.
n0bff
BFF(Backends for Frontend) of n0stack API. This provide features: API gateway, authentication, authorization and so on.
n0core
The example for implementations about n0stack API.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
How to develop
- see also Makefile
- Start containers
make build-builder # once
make up
- Start a Agent
- Recommended way is...
- Boot VM
- Deploy agent to booted VM
- Recommended way is...
- Develop features and restart containers or a agent
License
Directories
¶
| Path | Synopsis |
|---|---|
|
build
|
|
|
n0core
|
|
|
pkg/api/provisioning/virtualmachine
Package statik contains static assets.
|
Package statik contains static assets. |
|
pkg/datastore
Example func SomeEndpoint(ctx context.COntext, req SomeRequest) error { // validation datastore.Lock(req.Key) defer datastore.Unlock(req.Key) tx := transaction.Begin() defer tx.Rollback() // API Process tx.Done() return nil }
|
Example func SomeEndpoint(ctx context.COntext, req SomeRequest) error { // validation datastore.Lock(req.Key) defer datastore.Unlock(req.Key) tx := transaction.Begin() defer tx.Rollback() // API Process tx.Done() return nil } |
|
n0proto.go
|
|
|
deployment/v0
Package pdeployment is a reverse proxy.
|
Package pdeployment is a reverse proxy. |
|
iam/v0
Package piam is a reverse proxy.
|
Package piam is a reverse proxy. |
|
pkg/transaction
Example func SomeEndpoint(ctx context.COntext, req SomeRequest) error { // validation tx := transaction.Begin() defer tx.Rollback() // API Process if err := Process(); err != nil { return err } tx.PushRollback("Process", func() error { return InverseProcess() }) tx.Done() return nil }
|
Example func SomeEndpoint(ctx context.COntext, req SomeRequest) error { // validation tx := transaction.Begin() defer tx.Rollback() // API Process if err := Process(); err != nil { return err } tx.PushRollback("Process", func() error { return InverseProcess() }) tx.Done() return nil } |
|
pool/v0
Package ppool is a reverse proxy.
|
Package ppool is a reverse proxy. |
|
provisioning/v0
Package pprovisioning is a reverse proxy.
|
Package pprovisioning is a reverse proxy. |