https://github.com/jochumdev/microwire-plugins
Plugins for proof of concept microwire.
https://github.com/jochumdev/microwire-plugins
Last synced: about 1 year ago
JSON representation
Plugins for proof of concept microwire.
- Host: GitHub
- URL: https://github.com/jochumdev/microwire-plugins
- Owner: jochumdev
- Created: 2022-10-02T07:22:20.000Z (over 3 years ago)
- Default Branch: v5
- Last Pushed: 2022-10-04T16:24:38.000Z (over 3 years ago)
- Last Synced: 2025-01-17T02:40:58.568Z (over 1 year ago)
- Language: Go
- Size: 1.63 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Plugins [](https://opensource.org/licenses/Apache-2.0) [](https://godoc.org/github.com/go-micro/microwire-plugins) [](https://goreportcard.com/report/github.com/go-micro/microwire-plugins) [](https://hits.seeyoufarm.com)
This repo contains the plugins for the microwire POC.
## Overview
Micro tooling is built on a powerful pluggable architecture. Plugins can be swapped out with zero code changes.
This repository contains plugins for all micro related tools. Read on for further info.
## Getting Started
- [Plugins](#plugins)
- [Overview](#overview)
- [Getting Started](#getting-started)
- [Contents](#contents)
- [Usage](#usage)
- [Env](#env)
- [Flags](#flags)
- [Options](#options)
- [Build Pattern](#build-pattern)
- [Community](#community)
## Contents
Contents of this repository:
| Directory | Description |
| --------- | ----------------------------------------------------------------|
| Broker | PubSub messaging; NATS, NSQ, RabbitMQ, Kafka |
| Client | RPC Clients; gRPC, HTTP |
| Codec | Message Encoding; BSON, Mercury |
| Micro | Micro Toolkit Plugins |
| Registry | Service Discovery; Etcd, Gossip, NATS |
| Selector | Load balancing; Label, Cache, Static |
| Server | RPC Servers; gRPC, HTTP |
| Transport | Bidirectional Streaming; NATS, RabbitMQ |
| Wrapper | Middleware; Circuit Breakers, Rate Limiting, Tracing, Monitoring|
## Usage
Plugins can be added to go-micro in the following ways. By doing so they'll be available to set via command line args or environment variables.
Import the plugins in a `plugins.go` file
```go
package main
import (
_ "github.com/go-micro/microwire-plugins/broker/rabbitmq/v5"
_ "github.com/go-micro/microwire-plugins/registry/kubernetes/v5"
_ "github.com/go-micro/microwire-plugins/transport/nats/v5"
)
```
Create your service and ensure you call `service.Init`
```go
package main
import (
"github.com/go-micro/microwire/v5"
"github.com/go-micro/microwire/v5/logger"
)
func main() {
service, err := micro.NewService(
// Set service name
micro.Name("my.service"),
)
if err != nil {
logger.Fatal(err)
}
// Parse CLI flags
service.Init()
}
```
Build your service
```
go build -o service ./main.go ./plugins.go
```
### Env
Use environment variables to set the
```
MICRO_BROKER=rabbitmq \
MICRO_REGISTRY=kubernetes \
MICRO_TRANSPORT=nats \
./service
```
### Flags
Or use command line flags to enable them
```shell
./service --broker=rabbitmq --registry=kubernetes --transport=nats
```
### Options
Import and set as options when creating a new service
```go
import (
"github.com/go-micro/microwire/v5"
"github.com/go-micro/microwire-plugins/registry/kubernetes/v5"
)
func main() {
registry := kubernetes.NewRegistry() //a default to using env vars for master API
service, _ := micro.NewService(
// Set service name
micro.Name("my.service"),
// Set service registry
micro.Registry(registry),
)
}
```
## Build Pattern
An anti-pattern is modifying the `main.go` file to include plugins. Best practice recommendation is to include
plugins in a separate file and rebuild with it included. This allows for automation of building plugins and
clean separation of concerns.
Create file plugins.go
```go
package main
import (
_ "github.com/go-micro/microwire-plugins/broker/rabbitmq/v5"
_ "github.com/go-micro/microwire-plugins/registry/kubernetes/v5"
_ "github.com/go-micro/microwire-plugins/transport/nats/v5"
)
```
Build with plugins.go
```shell
go build -o service main.go plugins.go
```
Run with plugins
```shell
MICRO_BROKER=rabbitmq \
MICRO_REGISTRY=kubernetes \
MICRO_TRANSPORT=nats \
service
```
## Community
- [Discord](https://discord.gg/qV3HvnEJfB)
- [Slack](https://join.slack.com/t/go-micro/shared_invite/zt-175aaev1d-iHExPTlfxvfkOeeKLIYEYw)
- [QQ Group](https://jq.qq.com/?_wv=1027&k=5Gmrfv9i)