protoserver-go

Protoserver

Configurable containers to prototype services for a Kubernetes stack!

About The Project

Rapid prototyping can be a great tool for desinging and developing a project. Getting a Kubernetes stack up to test the flow of an application is great when each service will included structured logging and monitoring services.

Each Protoserver can be configured to certain MODES:

• STUB - to return a fixed response for each endpoint
• RELAY - to forward request to another internal or external service
• AGENT - to process request based on configured preset MACROS

You can progressively replace mocked/stubbed services with your own services. This project will let you start designing at the Kubernetes stack level.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• ![Go][Golang]
• ![Docker]

(back to top)

Usage

Usage of this respo will soon only require pre-built Docker Images that will be on https://hub.docker.com/u/kyledinh. I will be writing Usage Documentation soon, the work so far can be found in the examples directory.

See the examples directory to get started.

• Provide Docker container images on: https://hub.docker.com/u/kyledinh
• Examples to deploy locally with Docker Desktop
• Examples to deploy hosted Kubernetes stack like Linode or GKE
• Provide tools to view/manage Kubernetes stack (kt)

(back to top)

This Repo Development

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This script will query your local machine for software and their version.

• Check your local installation for dependencies and their version

  make check
  

Installation

The Makefile will provide scripts to install all the local dependencies.

1. Clone the repo

   git clone https://github.com/kyledinh/protoserver-go.git
   

2. Install packages

   make setup 
   

(back to top)

Roadmap

• STUB, RELAY action
• Structured Logging
• Auth Middleware with JWT
• Tooling for development - linkt to https://github.com/kyledinh/btk-go
• Tooling Kubernetes stack, deploy/view/monitoring
• Prometheus monitoring
• Example Usages
  • Local
  • GKE

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the Apache License. See LICENSE for more information.

(back to top)

Contact

Kyle Dinh - @iamslowblood

Project Link: https://github.com/kyledinh/protoserver-go

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Best README Template
• BTK - Go Project Dev Tools

(back to top)