Skip to content
A simple cloud provider using gRPC
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github
bin update gitignore to reduce changes on bin/ Nov 23, 2018
build use delete nginx container Apr 30, 2019
deploy
docs
n0bff use delete nginx container Apr 30, 2019
n0cli add cli options and update yaml to support undelete Apr 3, 2019
n0core
n0proto.go
n0proto.swagger.json commit swagger changes which is forgot May 4, 2019
n0proto typo about block_storage.proto May 3, 2019
.dockerignore
.gitignore update for changed directory structures of n0cli Apr 3, 2019
.travis.yml
Dockerfile go mod checksums depend on golang minor versions, so uniform Dockerfi… Apr 29, 2019
LICENSE
Makefile
README.md add "How to develop" to README.md May 4, 2019
VERSION
docker-compose.yml
go.mod add openapi options Apr 30, 2019
go.sum go mod checksums depend on golang minor versions, so uniform Dockerfi… Apr 29, 2019
setup.py update n0test tdt_generator Jan 24, 2019

README.md

n0stack

Build Status CircleCI Go Report Card

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

  1. 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"
  1. Download n0cli from Github releases.
  2. Try use cases.

Documentations

Gitter Documentation Status GoDoc

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

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

How to develop

  1. Start containers
make build-builder # once
make up
  1. Start a Agent
  2. Develop features and restart containers or a agent

License

License

FOSSA Status

You can’t perform that action at this time.