osm

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.

Table of Contents

• Overview
  • Core Principles
  • Features
  • SMI Specification Support
• OSM Design
• Getting Started
  • Prerequisites
  • Installation Demo
  • OSM CLI Install
    • Run Install Pre-flight Checks
    • Install OSM
  • Using OSM
  • OSM Usage Patterns
• Demo and Examples
• Community
• Development Guide
• Code of Conduct
• License

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.

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 Service Mesh Interface (SMI)

Features

1. 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

SMI Specification support

OSM Design

Read more about OSM's high level goals, design, and architecture.

Getting Started

Below are quick getting started instructions. For a more detailed example usage guide and demo walkthrough, see the OSM Example Usage Guide.

Prerequisites

• Kubernetes cluster running Kubernetes v1.15.0 or greater
• kubectl current context is configured for the target cluster install
  • kubectl config current-context

Installation Demo

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.

sudo mv ./osm /usr/local/bin/osm

Run Install Pre-flight Checks

$ osm check --pre-install
ok: initialize Kubernetes client
ok: query Kubernetes API
ok: Kubernetes version
ok: can create namespaces
ok: can create customresourcedefinitions
ok: can create clusterroles
ok: can create clusterrolebindings
ok: can create mutatingwebhookconfigurations
ok: can create serviceaccounts
ok: can create services
ok: can create deployments
ok: can create configmaps
ok: can read secrets
ok: can modify iptables
All checks successful!

Install OSM

$ osm install

See the installation guide for more detailed options.

Using OSM

After installing OSM, onboard a microservice application to the service mesh.

OSM Usage Patterns

1. Ingress and Egress
2. Observability
3. Certificates
4. Sidecar Injection

Demo and Examples

The automated demo shows how OSM can manage, secure and provide observability for microservice environments.

To explore the same demo step by step, see the example usage guide.

Community

Connect with the Open Service Mesh community:

• GitHub issues and pull requests in this repo
• OSM Slack (coming soon)
• Public Community Call (coming soon)
• 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.