Plugin v1alpha1 API Reference

Plugin v1alpha1 API reference documentation.

Packages:

plugin.flomesh.io/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

    ChainPluginSpec

    (Appears on:PluginChainSpec)

    ChainPluginSpec is the type used to represent plugins within chain.

    FieldDescription
    name
    string

    Name defines the name of chain.

    plugins
    []string

    Plugins defines the plugins within chain.

    ChainSelectorSpec

    (Appears on:PluginChainSpec)

    ChainSelectorSpec is the type used to represent plugins for plugin chain.

    FieldDescription
    podSelector
    Kubernetes meta/v1.LabelSelector    		(Optional)

    PodSelector for pods. Existing pods are selected by this will be the ones affected by this plugin chain.

    namespaceSelector
    Kubernetes meta/v1.LabelSelector    		(Optional)

    NamespaceSelector for namespaces. Existing pods are selected by this will be the ones affected by this plugin chain.

    Plugin

    Plugin is the type used to represent a Plugin policy.

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta    		(Optional)

    Object’s metadata

    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    PluginSpec    		(Optional)

    Spec is the PlugIn specification



    priority
    float32

    priority defines the priority of the plugin.

    pipyscript
    string

    Script defines the Script of the plugin.

    status
    PluginStatus    		(Optional)

    Status is the status of the Plugin configuration.

    PluginChain

    PluginChain is the type used to represent a PluginChain.

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta    		(Optional)

    Object’s metadata

    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    PluginChainSpec    		(Optional)

    Spec is the PluginChain specification



    chains
    []ChainPluginSpec

    Chains defines the plugins within chains

    selectors
    ChainSelectorSpec

    Selectors defines the selectors of chains.

    status
    PluginChainStatus    		(Optional)

    Status is the status of the PluginChain configuration.

    PluginChainSpec

    (Appears on:PluginChain)

    PluginChainSpec is the type used to represent the PluginChain specification.

    FieldDescription
    chains
    []ChainPluginSpec

    Chains defines the plugins within chains

    selectors
    ChainSelectorSpec

    Selectors defines the selectors of chains.

    PluginChainStatus

    (Appears on:PluginChain)

    PluginChainStatus is the type used to represent the status of a PluginChain resource.

    FieldDescription
    currentStatus
    string    		(Optional)

    CurrentStatus defines the current status of a PluginChain resource.

    reason
    string    		(Optional)

    Reason defines the reason for the current status of a PluginChain resource.

    PluginConfig

    PluginConfig is the type used to represent a plugin config policy.

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta    		(Optional)

    Object’s metadata

    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    PluginConfigSpec    		(Optional)

    Spec is the PlugIn specification



    plugin
    string

    Plugin is the name of plugin.

    destinationRefs
    []Kubernetes core/v1.ObjectReference

    DestinationRefs is the destination references of plugin.

    config
    k8s.io/apimachinery/pkg/runtime.RawExtension

    Config is the config of plugin.

    status
    PluginConfigStatus    		(Optional)

    Status is the status of the plugin config configuration.

    PluginConfigSpec

    (Appears on:PluginConfig)

    PluginConfigSpec is the type used to represent the plugin config specification.

    FieldDescription
    plugin
    string

    Plugin is the name of plugin.

    destinationRefs
    []Kubernetes core/v1.ObjectReference

    DestinationRefs is the destination references of plugin.

    config
    k8s.io/apimachinery/pkg/runtime.RawExtension

    Config is the config of plugin.

    PluginConfigStatus

    (Appears on:PluginConfig)

    PluginConfigStatus is the type used to represent the status of a PluginConfig resource.

    FieldDescription
    currentStatus
    string    		(Optional)

    CurrentStatus defines the current status of a PluginConfig resource.

    reason
    string    		(Optional)

    Reason defines the reason for the current status of a PluginConfig resource.

    PluginSpec

    (Appears on:Plugin)

    PluginSpec is the type used to represent the Plugin policy specification.

    FieldDescription
    priority
    float32

    priority defines the priority of the plugin.

    pipyscript
    string

    Script defines the Script of the plugin.

    PluginStatus

    (Appears on:Plugin)

    PluginStatus is the type used to represent the status of a Plugin resource.

    FieldDescription
    currentStatus
    string    		(Optional)

    CurrentStatus defines the current status of a Plugin resource.

    reason
    string    		(Optional)

    Reason defines the reason for the current status of a Plugin resource.

    Generated with gen-crd-api-reference-docs on git commit 8abe9ab.

    Feedback

    Was this page helpful?


    Last modified June 18, 2024: Update API version in gateway manifests to align with gwapi 1.1 Signed-off-by: Addo.Zhang <duwasai@gmail.com> (c83f664)