https://github.com/datawire/mdk

Microservices Development Kit. Open source SDK for building microservices in multiple languages.
https://github.com/datawire/mdk

Last synced: 13 days ago
JSON representation

Microservices Development Kit. Open source SDK for building microservices in multiple languages.

• Host: GitHub
• URL: https://github.com/datawire/mdk
• Owner: datawire
• License: apache-2.0
• Archived: true
• Created: 2016-06-15T13:45:07.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-12-13T18:49:51.000Z (almost 8 years ago)
• Last Synced: 2024-10-13T15:42:55.806Z (about 1 month ago)
• Language: Python
• Homepage: https://www.datawire.io
• Size: 893 KB
• Stars: 58
• Watchers: 29
• Forks: 6
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
The Datawire Microservices Development Kit

=======

The Datawire Microservices Development Kit lets developers code and

test microservices using their native languages and frameworks. The

MDK includes APIs for:

* registering and locating microservices

* distributed logging

* resilient connections (e.g., circuit breakers)

The MDK is currently available in Java, JavaScript, Ruby, and Python

versions.

Quick Start

--------

Visit https://app.datawire.io to create a free Datawire account, and see step-by-step instructions.

Slow Start (for developers)

--------

See

https://datawire.github.io/mdk-docs/latest/main/getting-started/index.html on how to install the MDK from the command line. Currently, there is an implementation dependency on the Datawire cloud services for service discovery. We plan to remove this requirement in the near future. 

Architecture

------------

The MDK is implemented as a series of *protocols*. These protocols are defined in [Quark](https://github.com/datawire/quark). The

Quark transpiler then compiles these protocol definitions into language native MDKs.

Environment Variables

---------------------

The MDK can be configured via environment variables.

The officially supported ones will be described in the [user-facing documentation](https://datawire.github.io/mdk-docs/latest/main/getting-started/index.html), but here is a list of the ones the code currently supports:

* `DATAWIRE_TOKEN`: Authentication token for Mission Control server (or the MCP server set with `MDK_SERVER_URL`, see below).

  If set the MDK will talk to the MCP and send log messages there, as well as using it for discovery.

* `MDK_ENVIRONMENT`: Operational environment to use.

  Services in different environments can't see each other.

  If in the form `:` then services not found in `` will be looked up in the `` operational environment.

  If not set the environment defaults to `sandbox`.

* `MDK_DISCOVERY_SOURCE`: Discovery source to use, overriding default discovery source set by `DATAWIRE_TOKEN`.

  * A value of `datawire:` is the same as setting `DATAWIRE_TOKEN`.

  * A value of `synapse:path=` will read from Synapse filesystem dump.

  * A value of `static:nodes=` will use the specified `mdk_discovery.Node` instances.

* `MDK_SERVER_URL`: The server to talk to.

  Override to point at local MCP, or at the development server (`wss://mcp-develop.datawire.io/rtp`.)

* `MDK_FAILURE_POLICY` allows overriding the default 3-strikes-and-you're-blacklisted-for-30-seconds circuit breaker policy.

  * A value of `recording` sets a `mdk_discovery.RecordingFailurePolicyFactory`, which useful when writing unit tests.

* `MDK_EXPERIMENTAL`: If set enables experimental features, some of which may be insecure.

* `MDK_LOG_MESSAGES`: If set, e.g. to `1`, sent and received messages will be written out to files at `/tmp/mdk*.log`.