Repository files navigation

Your new microservice development environment friend. This CLI tool allows you to define a configuration to work with both local applications (Go, NodeJS, Rust or others) and forward some other applications over Kubernetes in case you don't want to run them locally.

✅ Define a unified way to setup applications for all your developers

✅ Run your local applications

✅ Hot reload your applications automatically when a change is made locally

✅ Port-forward an application locally using a remote one on Kubernetes (targeting a pod via label) or over SSH

✅ Forward traffic of a remote application over Kubernetes, SSH or TCP locally (see example forward types)

✅ Auto reconnect when a port-forward connection is lost

✅ Forward multiple times the same port locally, using an hostname

✅ Monitor your local and/or forwarded applications

$ brew install eko/homebrew-tap/monday

This will install the latest available release

You can download the latest version of the binary built for your architecture here:

• Architecturei386 [Linux]
• Architectureamd64 [Darwin /Linux]
• Architecturearm [Darwin /Linux]

Optionally, you can download and build it from the sources. You have to retrieve the project sources by using one of the following way:

$ go get -u github.com/eko/monday# or$ git clone https://github.com/eko/monday.git

Then, build the binary using the available target in Makefile:

$ make build

Configuration of Monday lives in one or multiple YAML files, depending on how you want to organize your files.

By default,monday init will initiates a~/monday.yaml file. You can customize the configuration directory by setting theMONDAY_CONFIG_PATH environment variable.

Please note that you can also split this configuration in multiple files by respecting the following pattern:~/monday.<something>.yaml, for instance:

• ~/monday.localapps.yaml
• ~/monday.forwards.yaml
• ~/monday.projects.yaml

This will help you navigate more easily in your configuration files.

Here is an example of a local application:

<:&graphql-localname:graphqlpath:$GOPATH/src/github.com/eko/graphqlwatch:truehostname:graphql.svc.local# Project will be available using this hostname on your machinesetup:# Setup, installation step in case specified path does not exists    -go get github.com/eko/graphqlbuild:# Optionally, you can define a build section to build your application before running itcommands:      -go build -o ./build/graphql-app cmd/# Here, just build the Go applicationenv:CGO_ENABLED:onrun:command:./build/graphql-app# Then, run it using this built binaryenv:# Optional, in case you want to specify some environment variables for this appHTTP_PORT:8005env_file:"github.com/eko/graphql/.env"# Or via a .env file alsofiles:# Optional, you can also declare some files content with dynamic values coming from your project YAML or simply copy files    -type:contentto:$GOPATH/src/github.com/eko/graphql/my_filecontent:|        This is my file content and here are the current project applications:          {{- range $app := .Applications }}          Name: {{ $app.Name }}          {{- end }}    -type:copyfrom:$GOPATH/src/github.com/eko/graphql/.env.distto:$GOPATH/src/github.com/eko/graphql/.env

Then, imagine this GraphQL instance needs to call a user-api but we want to forward it from a Kubernetes environment, we will define it as follows.

<:&user-api-forwardname:user-apitype:kubernetesvalues:context:staging# This is your kubernetes cluster (kubectl config context name)namespace:backendlabels:app:user-apihostname:user-api.svc.local# API will be available under this hostnameports:     -8080:8080

Well, you have defined both a local app and an application that needs to be forwarded, now just create the project!

 -name:graphqllocal:- *graphql-localforward:- *user-api-forward

Your project configuration is ready, you can now work easily with your microservices.

For an overview of what's possible to do with configuration file, please look at theconfiguration example directory here.

To learn more about the configuration, please take a look at theConfiguration Wiki page.

First, you have to initialize monday and edit your configuration file (you have aconfiguration example directory here).Run the following command and edit the~/monday.yaml configuration file just created for you:

⚠️Important note: Because Monday tries to be your best dev tool and manage things for you, you have to give it some chances to help you in editing host file and manipulating network interface for IP/port mapping.

That's why I suggest to run Monday using the following alias:

alias monday='sudo -E monday'

$ monday init

Once your configuration file is ready, you can simply run Monday:

$ monday [--ui]

Note the--ui option that will allow you to enable the user interface (you can also define aMONDAY_ENABLE_UI environment variable to enable it).

Or, you can run a specific project directly by running:

$ monday run [--ui]<project name>

When you want to edit your configuration again, simply run this command to open it in your favorite editor:

$ monday edit

The following environment variables can be used to tweak your Monday configuration:

You canjoin the community Slack space to discuss about your issues, new features or anything else regarding Monday.

Test suite can be run with:

$ gotest -v ./...