Skip to content

Commit f0bd30a

Browse files
authored
Merge pull request #174254 from nshankar13/nshankar/OSM_AKS_Addon_CLI_config_single_mesh
Update OSM AKS addon documentation
2 parents 6f82045 + e601dfd commit f0bd30a

5 files changed

+48
-3
lines changed

articles/aks/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -388,6 +388,8 @@
388388
href: open-service-mesh-nginx-ingress.md
389389
- name: Configure observability using Prometheus, Grafana, and Jaeger
390390
href: open-service-mesh-open-source-observability.md
391+
- name: Customize OSM CLI experience
392+
href: open-service-mesh-customize-add-on-experience.md
391393
- name: Configure Azure Monitor
392394
href: open-service-mesh-azure-monitor.md
393395
- name: Troubleshoot OSM

articles/aks/open-service-mesh-binary.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,7 @@ This article will discuss how to download the OSM client library to be used to o
3333
::: zone-end
3434

3535
> [!WARNING]
36-
> Do not attempt to install OSM from the binary using `osm install`. This will result in a installation of OSM that is not integrated as an add-on for AKS.
36+
> Do not attempt to install OSM from the binary using `osm install`. This will result in a installation of OSM that is not integrated as an add-on for AKS.
37+
38+
> [!NOTE]
39+
> It is recommended to configure the OSM CLI to [customize the OSM AKS addon experience](/open-service-mesh-customize-addon-experience.md) after installing the binary, before using the OSM CLI.
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Customize OSM CLI experience
3+
description: Customize OSM CLI experience with an osmconfig file.
4+
services: container-service
5+
ms.topic: article
6+
ms.date: 9/30/2021
7+
ms.custom: mvc, devx-track-azurecli
8+
ms.author: nshankar
9+
zone_pivot_groups: client-operating-system
10+
---
11+
12+
# Configure OSM CLI variables with an OSM_CONFIG file
13+
14+
Users can override the default OSM CLI configuration to enhance the add-on experience. This can be done by creating a config file, similar to `kubeconfig`. The config file can be either created at `$HOME/.osm/config.yaml`, or at a different path that is exported using the `OSM_CONFIG` environment variable.
15+
16+
The file must contain the following YAML formatted content:
17+
18+
```yaml
19+
install:
20+
kind: managed
21+
distribution: AKS
22+
namespace: kube-system
23+
```
24+
25+
If the file is not created at `$HOME/.osm/config.yaml`, remember to set the `OSM_CONFIG` environment variable to point to the path where the config file is created.
26+
27+
After setting OSM_CONFIG, the output of the `osm env` command should be the following:
28+
29+
```console
30+
$ osm env
31+
---
32+
install:
33+
kind: managed
34+
distribution: AKS
35+
namespace: kube-system
36+
```

articles/aks/open-service-mesh-deploy-new-application.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -415,4 +415,4 @@ trafficsplit.split.smi-spec.io/bookstore-split created
415415

416416
Set up a port forward tunnel to the `bookbuyer` pod and you should now see books being purchased from the `bookstore` v2 service. If you continue to watch the increment of purchases, you should notice a faster increment of purchases happening through the `bookstore` v2 service.
417417

418-
![OSM bookbuyer books boough UI](./media/aks-osm-addon/osm-bookbuyer-traffic-split-ui.png)
418+
![OSM bookbuyer books bought UI](./media/aks-osm-addon/osm-bookbuyer-traffic-split-ui.png)

articles/aks/open-service-mesh-troubleshoot.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -447,4 +447,8 @@ kubectl apply -f https://raw.githubusercontent.com/openservicemesh/osm/v0.8.2/ch
447447

448448
### Certificate management
449449

450-
Information on how to issue and manage certificates to Envoy proxy via the OSM control plane can be found on the [OpenServiceMesh docs site](https://docs.openservicemesh.io/docs/guides/certificates/).
450+
Information on how OSM issues and manages certificates to Envoy proxies running on application pods can be found on the [OpenServiceMesh docs site](https://docs.openservicemesh.io/docs/guides/certificates/).
451+
452+
### Upgrading Envoy
453+
454+
When a new pod is created in a namespace monitored by the add-on, OSM will inject an [envoy proxy sidecar](https://docs.openservicemesh.io/docs/guides/app_onboarding/sidecar_injection/) in that pod. Information regarding how to update the envoy version can be found in the [Upgrade Guide](https://docs.openservicemesh.io/docs/getting_started/upgrade/#envoy) on the OpenServiceMesh docs site.

0 commit comments

Comments
 (0)