How-to Guides

Learn how to use osm-edge

Install the osm-edge CLI

This section describes installing and using the osm CLI.

Install the osm-edge Control Plane

This section describes how to install/uninstall osm-edge on a Kubernetes cluster

Upgrade the osm-edge Control Plane

Upgrade Guide

Uninstall the osm-edge Control Plane and Components

Uninstall

Application onboarding

Onboard Services

Mesh configuration

osm-edge MeshConfig

Reconciler Guide

Reconciler Guide

Traffic Management

osm-edge’s traffic management stack support two distinct traffic policy modes, namely SMI traffic policy mode and permissive traffic policy mode. The traffic policy mode determines how osm-edge routes application traffic between pods within the service mesh. Additionally, ingress and egress functionality allows external access to and from the cluster respectively.

Certificate Management

osm-edge uses mTLS for encryption of data between pods as well as Pipy and service identity.

Observability

osm-edge’s observability stack includes Prometheus for metrics collection, Grafana for metrics visualization, Jaeger for tracing and Fluent Bit for log forwarding to a user-defined endpoint.

High Availability & Scalability

Learn how to scale osm-edge

Health Checks

Health Checks for osm-edge

Integrations

Integrations for osm-edge

Troubleshooting

Troubleshooting for osm-edge