Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peak-ai/ais-service-discovery-go
Cloud application library for Golang
https://github.com/peak-ai/ais-service-discovery-go
aws cloud cloud-functions go golang lambda service-discovery
Last synced: 7 days ago
JSON representation
Cloud application library for Golang
- Host: GitHub
- URL: https://github.com/peak-ai/ais-service-discovery-go
- Owner: peak-ai
- License: gpl-3.0
- Created: 2019-07-10T15:18:32.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-25T06:37:46.000Z (over 1 year ago)
- Last Synced: 2024-06-20T15:03:37.365Z (5 months ago)
- Topics: aws, cloud, cloud-functions, go, golang, lambda, service-discovery
- Language: Go
- Homepage:
- Size: 59.6 KB
- Stars: 77
- Watchers: 5
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Cloud Application Framework
This library aims to expose a common set of interfaces for handling common cloud platform tasks. Such as queuing messages, publishing events, calling cloud functions etc.
This library is AWS centric, however, can by modified and extended to support others. Using the interfaces and configuration options shown below.
Being AWS centric, the default options are:
- Locator / Service Discovery: AWS Cloudmap
- Request: AWS Lambda
- Pubsub: AWS SNS
- Queue: AWS SQS
- Automate: AWS SSM
## Registering a service - Cloudformation
For the Cloudmap locator, the easiest way to register a service is through Cloudformation (or Terraform etc):
```yaml
CloudMapService:
Type: AWS::ServiceDiscovery::Service
Properties:
Description: User service
Name: users
NamespaceId:
CreateUserInstance:
Type: "AWS::ServiceDiscovery::Instance"
Properties:
InstanceAttributes:
arn: create-user
handler: create-job-run
type: function
InstanceId: create-user
ServiceId:
Ref: CloudMapService
```
## Use with default settings
```golang
func main() {
d := discover.NewDiscovery()
token, err := d.Queue("acme-prod.my-service->my-queue", types.Request{
Body: []byte("{}"),
})
...
}
```
## Use with custom integrations
```golang
func main() {
...
d := discover.NewDiscovery(
discover.SetQueue(NewKafkaAdapter(kafkaClient)),
discover.SetPubsub(NewNATSAdapter(natsClient)),
discover.SetLocator(NewConsulLocator(consul)),
)
}
```
### Request
```golang
d := discover.NewDiscovery()
d.Request("my-namespace.users->create-user", types.Request{
Body: []byte("{ \"hello\": \"world\" }"),
})
```
### Queue
```golang
d := discover.NewDiscovery()
d.Queue("my-namespace.my-service->my-queue", types.Request{
Body: jsonString,
})
go func() {
messages, err := d.Listen("my-namespace.my-service->my-queue")
for message := range message {
log.Println(string(message.Body))
}
}()
```
### Pubsub
```golang
d := discovery.NewDiscovery()
d.Publish("my-namespace.my-service->my-event", types.Request{
Body: jsonEvent,
})
```
### Automate
```golang
d := discovery.NewDiscovery()
d.Automate("my-namespace.my-service->my-script", types.Request{
Body: jsonEvent,
})
```
## Custom integrations
You can customise the behaviour and create your own integrations by conforming to the following interfaces, and use the `SetLocator`, `SetQueue`, `SetPubsub`, `SetAutomate` and `SetFunction` methods when creating an instance of the Discovery library.
### Locator interface
```golang
Discover(signature *types.Signature) (*types.Service, error)
```
### Queue interface
```golang
// QueueAdapter -
type QueueAdapter interface {
// Queue a message, return a token or message id
QueueWithOpts(service *types.Service, request types.Request, opts types.Options) (string, error)
ListenWithOpts(service *types.Service, opts types.Options) (<-chan *types.Response, error)
}
```
### Function interface
```golang
// FunctionAdapter -
type FunctionAdapter interface {
CallWithOpts(service *types.Service, request types.Request, opts types.Options) (*types.Response, error)
}
```
### AutomateAdapter interface
```golang
// AutomateAdapter -
type AutomateAdapter interface {
ExecuteWithOpts(service *types.Service, request types.Request, opts types.Options) (*types.Response, error)
}
```
### PubsubAdapter interface
```golang
// PubsubAdapter -
type PubsubAdapter interface {
PublishWithOpts(service *types.Service, request types.Request, opts types.Options) error
SubscribeWithOpts(service *types.Service, opts types.Options) (<-chan *types.Response, error)
}
```
_Acknowledgements:_ inspired by the amazing work at [Micro](https://github.com/micro/micro)