Enable plug-ins to extend ASM capabilities - Alibaba Cloud Service Mesh

Service Mesh (ASM) extends its capabilities by presetting features in the plug-in marketplace. You can use these out-of-the-box features as needed. This topic describes how to enable a plug-in to extend the capabilities of ASM.

Prerequisites

An ASM instance of v1.12.4.0-g7d140f10-aliyun or later is created. For more information, see Create an ASM instance and Update an ASM instance.

Enable a plug-in

Log on to the ASM console.
In the left-side navigation pane, choose Service Mesh > Mesh Management.
On the Mesh Management page, find the ASM instance that you want to configure. Click the name of the ASM instance or click Manage in the Actions column.
On the details page of the ASM instance, choose Plugin Extension Center > Market Place in the left-side navigation pane.
On the Market Place page, click the card of the plug-in that you want to enable.
On the Plugin Detail page, click the Plugin User Guide tab to learn about the features of the plug-in and how to configure the YAML file.

On the Plugin Detail page, click the Plugin Config tab, set parameters, and then turn on Plugin Switch.

Parameter	Description
Plugin Effective scope	The scope where the plug-in takes effect. Valid values: Global: The plug-in takes effect on all workloads, including all the ingress gateways and sidecars in Kubernetes clusters. Workload Scope: The plug-in takes effect on the specified workloads or on all the workloads in the specified namespace. Gateway Scope: The plug-in takes effect on the specified ingress gateways.
Add workloads to effective scope	You can configure this parameter only when the Plugin Effective scope parameter is set to Workload Scope. Click Add workloads to effective scope. In the Add workloads to effective scope dialog box, select the namespace in which the workloads that you want to add reside, select the workload type, select the workloads that you want to add in the Select workloads section on the left, add the workloads to the selected section on the right, and then click OK. The workload type is Service or Deployment. You can view the workloads that are added to the effective scope in the Sidecars in the effective scope section on the Plugin Detail page.
Add namespaces to effective scope	You can configure this parameter only when the Plugin Effective scope is set to Workload Scope. Click Add namespaces to effective scope. In the Add namespaces to effective scope dialog box, click the tags of the namespaces that you want to add in the Namespaces not in effective scope section. The tags of the namespaces are automatically moved to the Namespaces in effective scope section. Then, click OK. You can view the namespaces that are added to the effective scope in the Sidecars in the effective scope section on the Plugin Detail page.
Add ASM Gateway to effective scope	You can configure this parameter only when the Plugin Effective scope is set to Gateway Scope. Click Add ASM Gateway to effective scope. In the Add ASM Gateway to effective scope dialog box, click the gateways that you want to add in the Select ASM Gateway section on the left, add the gateways to the selected section on the right, and then click OK. You can view the gateways that are added to the effective scope in the ASM Gateways in the effective scope section on the Plugin Detail page.
Plugin Config	You need to specify some parameters in the YAML code editor based on your business requirements. For more information about these parameters, see the Plugin User Guide tab.
Plugin Switch	The plug-in configurations take effect only after you turn on Plugin Switch.

Related operations

After the plug-in is enabled, you can perform the following operations on the Plugin Config tab of the Plugin Detail page.

Operation	Procedure
Change the effective scope of the plug-in	In the Plugin Effective scope section, click the scope within which the plug-in will take effect. In the Change Plugin Effective Scope message, click OK.
Add workloads to the effective scope	You can configure this parameter only when the Plugin Effective scope is set to Workload Scope. Click Add workloads to effective scope. In the Add workloads to effective scope dialog box, select the namespace in which the workloads that you want to add reside, select the workload type, select the workloads that you want to add in the Select workloads section on the left, add the workloads to the selected section on the right, and then click OK. The workload type is Service or Deployment. You can view the workloads that are added to the effective scope in the Sidecars in the effective scope section on the Plugin Detail page.
Add namespaces to the effective scope	You can configure this parameter only when the Plugin Effective scope is set to Workload Scope. Click Add namespaces to effective scope. In the Add namespaces to effective scope dialog box, click the tags of the namespaces that you want to add in the Namespaces not in effective scope section. The tags of the namespaces are automatically moved to the Namespaces in effective scope section. Then, click OK. You can view the namespaces that are added to the effective scope in the Sidecars in the effective scope section on the Plugin Detail page.
Add gateways to the effective scope	You can configure this parameter only when the Plugin Effective scope is set to Gateway Scope. Click Add ASM Gateway to effective scope. In the Add ASM Gateway to effective scope dialog box, click the gateways that you want to add in the Select ASM Gateway section on the left, add the gateways to the selected section on the right, and then click OK. You can view the gateways that are added to the effective scope in the ASM Gateways in the effective scope section on the Plugin Detail page.
Edit the plug-in configuration YAML file	In the Plugin Config section, click Update, edit the YAML file, and then click Save in the upper-right corner of the YAML code editor. The new configurations take effect immediately.
Remove workloads from the effective scope	In the Sidecars in the effective scope section, find the workload that you want to remove, and click Unbind in the Actions column. In the Remove effective scope message, click OK.
Remove gateways from the effective scope	In the Sidecars in the effective scope section, click the icon in the tag of the gateway that you want to remove. In the Remove effective scope message, click OK.
Disable the plug-in	Turn off Plugin Switch at the bottom of the page. In the Disable the Plugin message, click OK. Important After you disable the plug-in, the system stability or business logic may be affected and unexpected issues may occur. Exercise caution when you perform this operation.