osm

README

Open Service Mesh (OSM)

Open Service Mesh (OSM) is a lightweight, extensible, Cloud Native service mesh that allows users to uniformly manage, secure, and get out-of-the-box observability features for highly dynamic microservice environments.

Guided by 4 core principles:

1. Simple to understand and contribute to
2. Effortless to install, maintain, and operate
3. Painless to troubleshoot
4. Easy to configure via SMI

Overview

OSM runs an Envoy based control plane on Kubernetes, can be configured with SMI APIs and works by injecting an Envoy proxy as a sidecar container next to each instance of your application. The proxy contains and executes rules around access control policies, implements routing configuration, and captures metrics. The control plane continually configures proxies to ensure policies and routing rules are up to date and ensures proxies are healthy.

Features of OSM:

1. More easily and transparently configure traffic shifting for deployments
2. Secure service to service communication by enabling mTLS
3. Define and execute fine grained access control policies for services
4. Observability and insights into application metrics for debugging and monitoring services
5. Integrate with external certificate management services/solutions with a pluggable interface.
6. Onboard applications onto the mesh by enabling automatic sidecar injection of Envoy proxy.

OSM Design

Read more about the high level goals, design and architecture here.

Getting Started

Prerequisites

• Kubernetes cluster running Kubernetes v1.15.0 or greater

OSM CLI Install

The simplest way of installing Open Service Mesh on a Kubernetes cluster is by using the osm CLI.

Download the osm binary from the Releases page. Unpack the osm binary and add it to $PATH to get started.

Install OSM

$ osm install

See the installation guide for more detailed options.

Using OSM

After installing OSM, add an application to the service mesh.

OSM Usage patterns

Refer to docs/patterns for OSM usage patterns.

Demo and deployment sample

The repository contains tools and scripts to compile and deploy the OSM control plane and a demo to show how OSM can manage, secure and provide observability for microservice environments; all on a user-provisioned Kubernetes cluster. See the demo instructions to get a sense of what we've accomplished and are working on.

Community

You can reach the Open Service Mesh community and developers via the following channels:

• OSM Slack (TBD)
• Public Community Call (TBD)
• Mailing list

Development Guide

If you would like to contribute to OSM, check out the development guide

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. See CODE_OF_CONDUCT.MD for further details.

License

This software is covered under the MIT license. You can read the license here.