aepc

command
v0.0.0-...-2c1eb2d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 15, 2023 License: MIT Imports: 3 Imported by: 0

README

aepc

Generates AEP-compliant RPCs from proto messages. See the main README.md for usage.

Purpose

aepc is designed to primarily work off of a resource model: rather than having individual RPCs / methods on a resource, the user declares resources that live under a service. The common operations against a resource (Create, Read, Update, List, and Delete) are generatable based on the desired control plane standard, such as the AEP standard or custom resource definitions for the Kubernetes Resource Model.

Design

aepc works off of an internal "hub" representation of a resource, while each of the consumers and producers is a "spoke", using the resource information for generation of service, clients, or documentation:

flowchart LR
    hub("unified service and resource hub")
    protoResources("proto messages")
    proto("protobuf")
    crd("Custom Resource Definitions (K8S)")
    http("HTTP REST APIs")
    protoResources --> hub
    hub  --> proto
    hub  --> http
    hub  --> crd

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
writer

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL