https://github.com/printfcoder/go-plugins
Plugins for external infrastructure dependencies
https://github.com/printfcoder/go-plugins
Last synced: 5 months ago
JSON representation
Plugins for external infrastructure dependencies
- Host: GitHub
- URL: https://github.com/printfcoder/go-plugins
- Owner: printfcoder
- License: apache-2.0
- Fork: true (st3v/go-plugins)
- Created: 2020-09-17T10:07:52.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-17T12:44:20.000Z (almost 6 years ago)
- Last Synced: 2024-06-21T04:39:47.612Z (about 2 years ago)
- Language: Go
- Homepage:
- Size: 4.94 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Plugins [](https://opensource.org/licenses/Apache-2.0) [](https://godoc.org/github.com/micro/go-plugins) [](https://travis-ci.org/micro/go-plugins) [](https://goreportcard.com/report/github.com/micro/go-plugins)
Go plugins is a place for community maintained plugins.
## Overview
Micro is built as a pluggable framework using Go interfaces. Plugins enable you to swap out the underlying infrastructure without having
to rewrite all your code. This enables running the same software in multiple environments without a ton of work. Read further for more info.
## Getting Started
* [Contents](#contents)
* [Usage](#usage)
* [Build](#build)
## 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/micro/go-plugins/broker/rabbitmq/v2"
_ "github.com/micro/go-plugins/registry/kubernetes/v2"
_ "github.com/micro/go-plugins/transport/nats/v2"
)
```
Create your service and ensure you call `service.Init`
```go
package main
import (
"github.com/micro/go-micro/v2"
)
func main() {
service := micro.NewService(
// Set service name
micro.Name("my.service"),
)
// Parse CLI flags
service.Init()
}
```
Build your service
```
go build -o service ./main.go ./plugins.go
```
### Environment Variables
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/micro/go-micro/v2"
"github.com/micro/go-plugins/registry/kubernetes/v2"
)
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
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/micro/go-plugins/broker/rabbitmq/v2"
_ "github.com/micro/go-plugins/registry/kubernetes/v2"
_ "github.com/micro/go-plugins/transport/nats/v2"
)
```
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
```