nano

README

Nano

A Golang Microservices Framework Inspired By Micro.

Overview

Nano addresses the key requirements for building services in the cloud. It leverages the microservices architecture pattern and provides a set of services which act as the building blocks of a platform. Nano deals with the complexity of distributed systems and provides simpler programmable abstractions to build on.

Contents

• Introduction - A high level introduction to Nano
• Getting Started - The helloworld quickstart guide
• Upgrade Guide - Update your nano project to use nano v1.
• Architecture - Describes the architecture, design and tradeoffs
• Reference - In-depth reference for Micro CLI and services
• Resources - External resources and contributions
• Roadmap - Stuff on our agenda over the long haul
• FAQ - Frequently asked questions

Getting Started

Install nano

go install github.com/ebelanja/nano@latest

Run the server

nanoctl server

Login with the username 'admin' and password 'nano':

$ nanoctl login
Enter username: admin
Enter password:
Successfully logged in.

See what's running:

$ nanoctl services
api
auth
broker
config
events
network
proxy
registry
runtime
server
store

Run a service

nanoctl run github.com/micro/services/helloworld

Now check the status of the running service

$ nanoctl status
NAME		VERSION	SOURCE					STATUS	BUILD	UPDATED	METADATA
helloworld	latest	github.com/micro/services/helloworld	running	n/a	4s ago	owner=admin, group=micro

We can also have a look at logs of the service to verify it's running.

$ nanoctl logs helloworld
2020-10-06 17:52:21  file=service/service.go:195 level=info Starting [service] helloworld
2020-10-06 17:52:21  file=grpc/grpc.go:902 level=info Server [grpc] Listening on [::]:33975
2020-10-06 17:52:21  file=grpc/grpc.go:732 level=info Registry [service] Registering node: helloworld-67627b23-3336-4b92-a032-09d8d13ecf95

Call the service

$ nanoctl helloworld call --name=Jane
{
	"msg": "Hello Jane"
}

Curl it

curl "http://localhost:8080/helloworld?name=John"

Write a client

package main

import (
	"context"
	"fmt"
	"time"

	"github.com/ebelanja/nano/service"
	proto "github.com/micro/services/helloworld/proto"
)

func main() {
	// create and initialise a new service
	srv := service.New()

	// create the proto client for helloworld
	client := proto.NewHelloworldService("helloworld", srv.Client())

	// call an endpoint on the service
	rsp, err := client.Call(context.Background(), &proto.CallRequest{
		Name: "John",
	})
	if err != nil {
		fmt.Println("Error calling helloworld: ", err)
		return
	}

	// print the response
	fmt.Println("Response: ", rsp.Message)
	
	// let's delay the process for exiting for reasons you'll see below
	time.Sleep(time.Second * 5)
}

Run it

nanoctl run .

For more see the getting started guide.

Usage

See the docs for detailed information on the architecture, installation and use.

License

See LICENSE which makes use of Apache 2.0