Skip to content

Latest commit

 

History

History
99 lines (74 loc) · 3.06 KB

overview.md

File metadata and controls

99 lines (74 loc) · 3.06 KB
Raw

Overview

This repository is the brain of Multy which translates Multy resources into cloud specific infrastructure.

The Multy Engine is a GRPC server that translates a multy infrastructure resource request into cloud specific resources.

File Structure

.
├── api # GRPC server
│    ├── aws # aws backend 
│    ├── deploy # runs terraform to refresh/plan/apply the translated config
│    ├── errors # common API errors returned 
│    ├── proto # contains all proto definitions and services exposed by the GRPC server 
│    │    ├── commonpb
│    │    ├── configpb
│    │    ├── credspb
│    │    ├── errorspb
│    │    └── resourcespb
│    ├── services # generic implementation of all resource services
│    └── util
├── cmd # command line tool to list/delete resources and start the server
├── db # database with user API keys and locks
├── encoder # translates all resources into terraform
├── flags
├── mhcl # implements custom go tag processors
├── resources
│    ├── common
│    ├── output # cloud specific resource outputs
│    └── types # contains every multy resource type and logic to create and export/import them
│         ├── aws # contains translation logic for every aws resource
│         ├── azure # contains translation logic for every azure resource
│         └── metadata # contains metadata about every resource
├── test
│    ├── _configs # resource unit tests
│    ├── deploy # unit tests for deployments
│    ├── e2e # end-to-end testing (deployment and test)
│    └── resources # unit tests for resource create / import and export
├── util 
└── validate # validation errors

Technologies

  • Golang (>=1.18)
  • Terraform (>=1.0) - Backend for resource deployment
  • MySQL - Store API keys and locks
  • Amazon S3 - Store internal user configuration (WIP to remove dependency)
  • GRPC

Running locally

  1. Clone repository
git clone https://github.com/multycloud/multy.git
cd multy
  1. Setup project
  1. Run server locally
go run main.go serve --env=local

You can add the --dry_run flag when running the server. Dry run mode will work normally except it will not deploy any resources.

  1. Deploy configuration

You can find some examples of infrastructure configuration on the Terraform provider

Check the docs for more details.

  1. Run tests

To run unit tests without running terraform, run:

go test ./test/... -v

To also test that terraform plan works correctly on the generated configs, you need to:

  1. Setup AWS (run aws configure) and Azure credentials (run az login)
  2. Run the tests go test ./test/... -v --tags=plan .