You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
OSM runs an Envoy-based control plane on Kubernetes, can be configured with [SMI](https://smi-spec.io/) APIs, and works by injecting an Envoy proxy as a sidecar container next to each instance of your application. [Read more](https://docs.openservicemesh.io/#features) on the service mesh scenarios enabled by Open Service Mesh.
16
14
15
+
All components of Azure Arc-enabled OSM are deployed on availability zones, making them zone redundant.
16
+
17
17
## Installation options and requirements
18
18
19
19
Azure Arc-enabled Open Service Mesh can be deployed through Azure portal, Azure CLI, an ARM template, or a built-in Azure policy.
If you're using an OpenShift cluster, skip to the [OpenShift installation steps](#install-osm-on-an-openshift-cluster).
68
68
69
69
Create the extension:
70
+
70
71
> [!NOTE]
71
-
> If you would like to pin a specific version of OSM, add the `--version x.y.z` flag to the `create` command. Note that this will set the value for `auto-upgrade-minor-version` to false.
72
+
> To pin a specific version of OSM, add the `--version x.y.z` flag to the `create` command. Note that this will set the value for `auto-upgrade-minor-version` to false.
72
73
73
74
```azurecli-interactive
74
75
az k8s-extension create --cluster-name $CLUSTER_NAME --resource-group $RESOURCE_GROUP --cluster-type connectedClusters --extension-type Microsoft.openservicemesh --scope cluster --name osm
@@ -181,8 +182,10 @@ Now, [install OSM with custom values](#setting-values-during-osm-installation).
181
182
[cert-manager](https://cert-manager.io/) is a provider that can be used for issuing signed certificates to OSM without
182
183
the need for storing private keys in Kubernetes. Refer to OSM's [cert-manager documentation](https://docs.openservicemesh.io/docs/guides/certificates/)
183
184
and [demo](https://docs.openservicemesh.io/docs/demos/cert-manager_integration/) to learn more.
185
+
184
186
> [!NOTE]
185
187
> Use the commands provided in the OSM GitHub documentation with caution. Ensure that you use the correct namespace in commands or specify with flag `--osm-namespace arc-osm-system`.
188
+
186
189
To install OSM with cert-manager as the certificate provider, create or append to your existing JSON settings file the `certificateProvider.kind`
187
190
value set to cert-manager as shown here. To change from the default cert-manager values specified in OSM documentation,
188
191
also include and update the subsequent `certmanager.issuer` lines.
@@ -218,29 +221,26 @@ To set required values for configuring Contour during OSM installation, append t
218
221
}
219
222
```
220
223
221
-
Now, [install OSM with custom values](#setting-values-during-osm-installation).
222
-
223
224
### Setting values during OSM installation
224
225
225
226
Any values that need to be set during OSM installation need to be saved to a single JSON file and passed in through the Azure CLI
226
227
install command.
227
228
228
229
After you create a JSON file with applicable values as described in the custom installation sections, set the file path as an environment variable:
229
230
230
-
```azurecli-interactive
231
-
export SETTINGS_FILE=<json-file-path>
232
-
```
231
+
```azurecli-interactive
232
+
export SETTINGS_FILE=<json-file-path>
233
+
```
233
234
234
-
Run the `az k8s-extension create` command to create the OSM extension, passing in the settings file using the
235
+
Run the `az k8s-extension create` command to create the OSM extension, passing in the settings file using the`--configuration-settings-file` flag:
235
236
236
-
`--configuration-settings-file` flag:
237
-
```azurecli-interactive
238
-
az k8s-extension create --cluster-name $CLUSTER_NAME --resource-group $RESOURCE_GROUP --cluster-type connectedClusters --extension-type Microsoft.openservicemesh --scope cluster --name osm --configuration-settings-file $SETTINGS_FILE
239
-
```
237
+
```azurecli-interactive
238
+
az k8s-extension create --cluster-name $CLUSTER_NAME --resource-group $RESOURCE_GROUP --cluster-type connectedClusters --extension-type Microsoft.openservicemesh --scope cluster --name osm --configuration-settings-file $SETTINGS_FILE
239
+
```
240
240
241
241
## Install Azure Arc-enabled OSM using ARM template
242
242
243
-
After connecting your cluster to Azure Arc, create a JSON file with the following format, making sure to update the \<cluster-name\> and \<osm-arc-version\> values:
243
+
After connecting your cluster to Azure Arc, create a JSON file with the following format, making sure to update the `<cluster-name>` and `<osm-arc-version>` values:
Run this command to install the OSM extension using the az CLI:
310
+
Run this command to install the OSM extension:
311
311
312
312
```azurecli-interactive
313
313
az deployment group create --name $DEPLOYMENT_NAME --resource-group $RESOURCE_GROUP --template-file $TEMPLATE_FILE_NAME
@@ -317,7 +317,9 @@ You should now be able to view the OSM resources and use the OSM extension in yo
317
317
318
318
## Install Azure Arc-enabled OSM using built-in policy
319
319
320
-
A built-in policy is available on Azure portal under the category of **Kubernetes** by the name of **Azure Arc-enabled Kubernetes clusters should have the Open Service Mesh extension installed**. This policy can be assigned at the scope of a subscription or a resource group. The default action of this policy is **Deploy if not exists**. However, you can choose to audit the clusters for extension installations by changing the parameters during assignment. You're also prompted to specify the version you wish to install (v1.0.0-1 or higher) as a parameter.
320
+
A built-in policy is available on Azure portal under the **Kubernetes** category: **Azure Arc-enabled Kubernetes clusters should have the Open Service Mesh extension installed**. This policy can be assigned at the scope of a subscription or a resource group.
321
+
322
+
The default action of this policy is **Deploy if not exists**. However, you can choose to audit the clusters for extension installations by changing the parameters during assignment. You're also prompted to specify the version you wish to install (v1.0.0-1 or higher) as a parameter.
321
323
322
324
## Validate installation
323
325
@@ -360,15 +362,17 @@ You should see a JSON output similar to:
360
362
}
361
363
```
362
364
365
+
For more commands that you can use to validate and troubleshoot the deployment of the Open Service Mesh (OSM) extension components on your cluster, see [our troubleshooting guide](extensions-troubleshooting.md#azure-arc-enabled-open-service-mesh)
366
+
363
367
## OSM controller configuration
364
368
365
-
OSM deploys a MeshConfig resource `osm-mesh-config` as a part of its control plane in arc-osm-system namespace. The purpose of this MeshConfig is to provide the mesh owner/operator the ability to update some of the mesh configurations based on their needs. to view the default values, use the following command.
369
+
OSM deploys a MeshConfig resource `osm-mesh-config` as a part of its control plane in `arc-osm-system` namespace. The purpose of this MeshConfig is to provide the mesh owner/operator the ability to update some of the mesh configurations based on their needs. To view the default values, use the following command.
@@ -416,6 +420,7 @@ For more information, see the [Config API reference](https://docs.openservicemes
416
420
417
421
> [!NOTE]
418
422
> Values in the MeshConfig `osm-mesh-config` are persisted across upgrades.
423
+
419
424
Changes to `osm-mesh-config` can be made using the `kubectl patch` command. In the following example, the permissive traffic policy mode is changed to false.
420
425
421
426
```azurecli-interactive
@@ -436,7 +441,7 @@ Alternatively, to edit `osm-mesh-config` in Azure portal, select **Edit configur
436
441
437
442
## Using Azure Arc-enabled OSM
438
443
439
-
To start using OSM capabilities, you need to first onboard the application namespaces to the service mesh. Download the OSM CLI from [OSM GitHub releases page](https://github.com/openservicemesh/osm/releases/). Once the namespaces are added to the mesh, you can configure the SMI policies to achieve the desired OSM capability.
444
+
To start using OSM capabilities, you need to first onboard the application namespaces to the service mesh. Download the OSM CLI from the [OSM GitHub releases page](https://github.com/openservicemesh/osm/releases/). Once the namespaces are added to the mesh, you can configure the SMI policies to achieve the desired OSM capability.
440
445
441
446
### Onboard namespaces to the service mesh
442
447
@@ -445,18 +450,19 @@ Add namespaces to the mesh by running the following command:
445
450
```azurecli-interactive
446
451
osm namespace add <namespace_name>
447
452
```
453
+
448
454
Namespaces can be onboarded from Azure portal as well by selecting **+Add** in the cluster's Open Service Mesh section.
449
455
450
456
[](media/tutorial-arc-enabled-open-service-mesh/osm-portal-add-namespace.jpg#lightbox)
451
457
452
-
More information about onboarding services can be found [here](https://docs.openservicemesh.io/docs/guides/app_onboarding/#onboard-services).
458
+
For more information about onboarding services, see the [Open Service Mesh documentation](https://docs.openservicemesh.io/docs/guides/app_onboarding/#onboard-services).
453
459
454
460
### Configure OSM with Service Mesh Interface (SMI) policies
455
461
456
462
You can start with a [sample application](https://docs.openservicemesh.io/docs/getting_started/install_apps/) or use your test environment to try out SMI policies.
457
463
458
464
> [!NOTE]
459
-
> If you are using a sample applications, ensure that their versions match the version of the OSM extension installed on your cluster. For example, if you are using v1.0.0 of the OSM extension, use the bookstore manifest from release-v1.0 branch of OSM upstream repository.
465
+
> If you use sample applications, ensure that their versions match the version of the OSM extension installed on your cluster. For example, if you are using v1.0.0 of the OSM extension, use the bookstore manifest from release-v1.0 branch of OSM upstream repository.
460
466
461
467
### Configuring your own Jaeger, Prometheus and Grafana instances
462
468
@@ -526,21 +532,23 @@ InsightsMetrics
526
532
### Navigating the OSM dashboard
527
533
528
534
1. Access your Arc connected Kubernetes cluster using this [link](https://aka.ms/azmon/osmux).
529
-
2. Go to Azure Monitor and navigate to the Reports tab to access the OSM workbook.
535
+
2. Go to Azure Monitor and navigate to the **Reports** tab to access the OSM workbook.
530
536
3. Select the time-range & namespace to scope your services.
- This tab shows a summary of all the http requests sent via service to service in OSM.
542
+
The **Requests** tab shows a summary of all the http requests sent via service to service in OSM.
543
+
537
544
- You can view all the services by selecting the service in the grid.
538
545
- You can view total requests, request error rate & P90 latency.
539
546
- You can drill down to destination and view trends for HTTP error/success code, success rate, pod resource utilization, and latencies at different percentiles.
540
547
541
548
#### Connections tab
542
549
543
-
- This tab shows a summary of all the connections between your services in Open Service Mesh.
550
+
The **Connections** tab shows a summary of all the connections between your services in Open Service Mesh.
551
+
544
552
- Outbound connections: total number of connections between Source and destination services.
545
553
- Outbound active connections: last count of active connections between source and destination in selected time range.
546
554
- Outbound failed connections: total number of failed connections between source and destination service.
@@ -590,17 +598,8 @@ When you use the `az k8s-extension` command to delete the OSM extension, the `ar
590
598
> [!NOTE]
591
599
> Use the az k8s-extension CLI to uninstall OSM components managed by Arc. Using the OSM CLI to uninstall is not supported by Arc and can result in undesirable behavior.
592
600
593
-
## Troubleshooting
594
-
595
-
Refer to the [extension troubleshooting guide](extensions-troubleshooting.md#azure-arc-enabled-open-service-mesh) for help with issues.
596
-
597
-
## Frequently asked questions
598
-
599
-
### Is the extension of Azure Arc-enabled OSM zone redundant?
600
-
601
-
Yes, all components of Azure Arc-enabled OSM are deployed on availability zones and are hence zone redundant.
602
-
603
601
## Next steps
604
602
605
-
> **Just want to try things out?**
606
-
> Get started quickly with an [Azure Arc Jumpstart](https://aka.ms/arc-jumpstart-osm) scenario using Cluster API.
603
+
- Just want to try things out? Get started quickly with an [Azure Arc Jumpstart](https://aka.ms/arc-jumpstart-osm) scenario using Cluster API.
604
+
- Get [troubleshooting help for Azure Arc-enabled OSM](extensions-troubleshooting.md#azure-arc-enabled-open-service-mesh).
605
+
- - Explore other [extensions for Arc-enabled Kubernetes](extensions-release.md).
Copy file name to clipboardExpand all lines: articles/azure-resource-manager/bicep/file.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -405,7 +405,7 @@ See [Arrays](./data-types.md#arrays) and [Objects](./data-types.md#objects) for
405
405
## Known limitations
406
406
407
407
* No support for the concept of apiProfile, which is used to map a single apiProfile to a set apiVersion for each resource type.
408
-
*No support for user-defined functions.
408
+
*User-defined functions are not supported at the moment. However, an experimental feature is currently accessible. For more information, see [User-defined functions in Bicep](./user-defined-functions.md).
409
409
* Some Bicep features require a corresponding change to the intermediate language (Azure Resource Manager JSON templates). We announce these features as available when all of the required updates have been deployed to global Azure. If you're using a different environment, such as Azure Stack, there may be a delay in the availability of the feature. The Bicep feature is only available when the intermediate language has also been updated in that environment.
Copy file name to clipboardExpand all lines: articles/bastion/quickstart-developer-sku.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Learn how to deploy Bastion using the Developer SKU.
4
4
author: cherylmc
5
5
ms.service: bastion
6
6
ms.topic: quickstart
7
-
ms.date: 12/04/2023
7
+
ms.date: 01/11/2024
8
8
ms.author: cherylmc
9
9
ms.custom: references_regions
10
10
---
@@ -27,7 +27,7 @@ The Bastion Developer SKU is a new [lower-cost](https://azure.microsoft.com/pric
27
27
28
28
When you deploy Bastion using the Developer SKU, the deployment requirements are different than when you deploy using other SKUs. Typically when you create a bastion host, a host is deployed to the AzureBastionSubnet in your virtual network. The Bastion host is dedicated for your use. When using the Developer SKU, a bastion host isn't deployed to your virtual network and you don't need an AzureBastionSubnet. However, the Developer SKU bastion host isn't a dedicated resource and is, instead, part of a shared pool.
29
29
30
-
Because the Developer SKU bastion resource isn't dedicated, the features for the Developer SKU are limited. See the Bastion configuration settings [SKU](configuration-settings.md) section for features by SKU. For more information about pricing, see the [Pricing](https://azure.microsoft.com/pricing/details/azure-bastion/) page. You can always upgrade the Developer SKU to a higher SKU if you need more features. See [Upgrade a SKU](upgrade-sku.md).
30
+
Because the Developer SKU bastion resource isn't dedicated, the features for the Developer SKU are limited. See the Bastion configuration settings [SKU](configuration-settings.md) section for features by SKU. You can always upgrade the Developer SKU to a higher SKU if you need more features. See [Upgrade a SKU](upgrade-sku.md).
31
31
32
32
## <aname="prereq"></a>Prerequisites
33
33
@@ -41,6 +41,7 @@ Because the Developer SKU bastion resource isn't dedicated, the features for the
41
41
* If you need example values, see the [Example values](#values) section.
42
42
* If you already have a virtual network, make sure it's selected on the Networking tab when you create your VM.
43
43
* If you don't have a virtual network, you can create one at the same time you create your VM.
44
+
* If you have a virtual network, make sure you have the rights to write to it.
0 commit comments