Setup OSM
Prerequisites
This demo of OSM v0.11.0 requires:
- a cluster running Kubernetes v1.19 or greater (using a cloud provider of choice, minikube, or similar)
- a workstation capable of executing Bash scripts
- The Kubernetes command-line tool -
kubectl
- the OSM code repo available locally
Note: This document assumes you have already installed credentials for a Kubernetes cluster in ~/.kube/config and
kubectl cluster-info
executes successfully.
Download and install the OSM command-line tool
The osm
command-line tool contains everything needed to install and configure Open Service Mesh.
The binary is available on the OSM GitHub releases page.
For GNU/Linux and macOS
Download the 64-bit GNU/Linux or macOS binary of OSM v0.11.0:
system=$(uname -s)
release=v0.11.0
curl -L https://github.com/openservicemesh/osm/releases/download/${release}/osm-${release}-${system}-amd64.tar.gz | tar -vxzf -
./${system}-amd64/osm version
For Windows
Download the 64-bit Windows OSM v0.11.0 binary via Powershell:
wget https://github.com/openservicemesh/osm/releases/download/v0.11.0/osm-v0.11.0-windows-amd64.zip -o osm.zip
unzip osm.zip
.\windows-amd64\osm.exe version
The osm
CLI can be compiled from source using this guide.
Installing OSM on Kubernetes
With the osm
binary downloaded and unzipped, we are ready to install Open Service Mesh on a Kubernetes cluster:
The command below shows how to install OSM on your Kubernetes cluster.
This command enables
Prometheus,
Grafana, and
Jaeger integrations.
The osm.enablePermissiveTrafficPolicy
chart parameter in the values.yaml
file instructs OSM to ignore any policies and
let traffic flow freely between the pods. With Permissive Traffic Policy mode enabled, new pods
will be injected with Envoy, but traffic will flow through the proxy and will not be blocked by access control policies.
Note: Permissive Traffic Policy mode is an important feature for brownfield deployments, where it may take some time to craft SMI policies. While operators design the SMI policies, existing services will continue to operate as they have been before OSM was installed.
export osm_namespace=osm-system # Replace osm-system with the namespace where OSM will be installed
export osm_mesh_name=osm # Replace osm with the desired OSM mesh name
osm install \
--mesh-name "$osm_mesh_name" \
--osm-namespace "$osm_namespace" \
--set=osm.enablePermissiveTrafficPolicy=true \
--set=osm.deployPrometheus=true \
--set=osm.deployGrafana=true \
--set=osm.deployJaeger=true
Read more on OSM’s integrations with Prometheus, Grafana, and Jaeger in the observability documentation.
Next Steps
Now that the OSM control plane is up and running, add applications to the mesh.
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.