plugin

Definition of plugin

A plug-in is a model definition relative to a component, and a plug-in is mainly used to describe the implementation of extended operation and maintenance capabilities of business components.Since the implementations of application operation and maintenance features have great commonalities, the plug-in itself only contains description and implementation, so that it can be reused.Must be bound to a component to have runtime state.At present, all plug-ins require a runtime to implement an operation and maintenance capability, such as performance analysis plug-ins and network governance plug-ins.Perhaps in the future we will define more plug-in types including virtual plug-in description models without runtime, such as monitoring visualization plug-ins, to describe the visual UI.

The runtime environment of a plug-in with runtime is consistent with the bound components in the following aspects:

  • Cyberspace is a crucial feature. Consistent cyberspace enables plugins to bypass and truncate component network traffic, set component local domain name resolution, and so on.
  • Storage Persistence Space This feature enables file exchange between plugins and components through the persistence directory.
  • environment variables This feature enables plugins to read the component’s environment variables.

Classification of plugins

Category Nameeffectcontrol
Performance Analysis ClassThe performance analysis page can be displayed by installing the performance analysis plug-in for the service
Ingress network classOne of the ServiceMesh plugin types that handles downstream traffic to componentsDynamic allocation of listening ports
export networkOne of the ServiceMesh plugin types that handles component upstream trafficSupport service discovery
Ingress and egress co-governance networkOne of the types of ServiceMesh plug-ins, while loading the upstream and downstream traffic of the processing componentsSupport service discovery
initialization typeThe service starts after the plug-in first starts and exits normally, user service data initialization or other initialization operations
general typeSuch as data backup, log collection

Plugin configuration items

The function of the configuration item is to describe the configuration information required by the plug-in, similar to the definition form. When the plug-in is instantiated (that is, when it is installed and bound by the component), the configuration form is generated according to the relevant metadata of the component.In addition to the basic environment variable requirements, the configuration of the plug-in generally needs to be combined with the port of the component and the metadata of the dependent component.For example, define the fuse configuration or routing configuration of the egress management plug-in on a dependent communication link.

Configuration items can be grouped, and each group of configuration items can be based on a certain metadata type.Currently supported metadata types include:component ports and downstream component ports.Each set of configuration items can also define its injection method, including:environment variables and active discovery.Configuration groups that rely on component metadata can only be obtained through active discovery.

read more

Plugin Development Instructions