go-micro.dev/v5@v5.12.0/internal/website/docs/architecture.md (about)

     1  ---
     2  layout: default
     3  ---
     4  
     5  ## Architecture
     6  
     7  An overview of the Go Micro architecture
     8  
     9  ## Overview
    10  
    11  Go Micro abstracts away the details of distributed systems. Here are the main features.
    12  
    13  - **Authentication** - Auth is built in as a first class citizen. Authentication and authorization enable secure
    14    zero trust networking by providing every service an identity and certificates. This additionally includes rule
    15    based access control.
    16  
    17  - **Dynamic Config** - Load and hot reload dynamic config from anywhere. The config interface provides a way to load application
    18    level config from any source such as env vars, file, etcd. You can merge the sources and even define fallbacks.
    19  
    20  - **Data Storage** - A simple data store interface to read, write and delete records. It includes support for many storage backends
    21  in the plugins repo. State and persistence becomes a core requirement beyond prototyping and Micro looks to build that into the framework.
    22  
    23  - **Service Discovery** - Automatic service registration and name resolution. Service discovery is at the core of micro service
    24    development. When service A needs to speak to service B it needs the location of that service. The default discovery mechanism is
    25    multicast DNS (mdns), a zeroconf system.
    26  
    27  - **Load Balancing** - Client side load balancing built on service discovery. Once we have the addresses of any number of instances
    28    of a service we now need a way to decide which node to route to. We use random hashed load balancing to provide even distribution
    29    across the services and retry a different node if there's a problem.
    30  
    31  - **Message Encoding** - Dynamic message encoding based on content-type. The client and server will use codecs along with content-type
    32    to seamlessly encode and decode Go types for you. Any variety of messages could be encoded and sent from different clients. The client
    33    and server handle this by default. This includes protobuf and json by default.
    34  
    35  - **RPC Client/Server** - RPC based request/response with support for bidirectional streaming. We provide an abstraction for synchronous
    36    communication. A request made to a service will be automatically resolved, load balanced, dialled and streamed.
    37  
    38  - **Async Messaging** - PubSub is built in as a first class citizen for asynchronous communication and event driven architectures.
    39    Event notifications are a core pattern in micro service development. The default messaging system is a HTTP event message broker.
    40  
    41  - **Pluggable Interfaces** - Go Micro makes use of Go interfaces for each distributed system abstraction. Because of this these interfaces
    42    are pluggable and allows Go Micro to be runtime agnostic. You can plugin any underlying technology.
    43  
    44  ## Design
    45  
    46  We will share more on architecture soon
    47  
    48  ## Related
    49  
    50  - [ADR Index](architecture/index.md)
    51  - [Configuration](config.md)
    52  - [Plugins](plugins.md)
    53  
    54  ## Example Usage
    55  
    56  Here's a minimal Go Micro service demonstrating the architecture:
    57  
    58  ```go
    59  package main
    60  
    61  import (
    62      "go-micro.dev/v5"
    63      "log"
    64  )
    65  
    66  func main() {
    67      service := micro.NewService(
    68          micro.Name("example"),
    69      )
    70      service.Init()
    71      if err := service.Run(); err != nil {
    72          log.Fatal(err)
    73      }
    74  }
    75  ```