go.ligato.io/vpp-agent/v3@v3.5.0/plugins/vpp/ifplugin/options.go (about)

     1  // Copyright (c) 2018 Cisco and/or its affiliates.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at:
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package ifplugin
    16  
    17  import (
    18  	"go.ligato.io/cn-infra/v2/config"
    19  	"go.ligato.io/cn-infra/v2/health/statuscheck"
    20  	"go.ligato.io/cn-infra/v2/logging"
    21  	"go.ligato.io/cn-infra/v2/servicelabel"
    22  
    23  	"go.ligato.io/vpp-agent/v3/plugins/govppmux"
    24  	"go.ligato.io/vpp-agent/v3/plugins/kvscheduler"
    25  	"go.ligato.io/vpp-agent/v3/plugins/netalloc"
    26  )
    27  
    28  // DefaultPlugin is a default instance of IfPlugin.
    29  var DefaultPlugin = *NewPlugin()
    30  
    31  // NewPlugin creates a new Plugin with the provides Options
    32  func NewPlugin(opts ...Option) *IfPlugin {
    33  	p := &IfPlugin{}
    34  
    35  	p.PluginName = "vpp-ifplugin"
    36  	p.StatusCheck = &statuscheck.DefaultPlugin
    37  	p.KVScheduler = &kvscheduler.DefaultPlugin
    38  	p.VPP = &govppmux.DefaultPlugin
    39  	p.ServiceLabel = &servicelabel.DefaultPlugin
    40  	p.AddrAlloc = &netalloc.DefaultPlugin
    41  
    42  	for _, o := range opts {
    43  		o(p)
    44  	}
    45  
    46  	if p.Log == nil {
    47  		p.Log = logging.ForPlugin(p.String())
    48  	}
    49  	if p.Cfg == nil {
    50  		p.Cfg = config.ForPlugin(p.String(),
    51  			config.WithCustomizedFlag(config.FlagName(p.String()), "vpp-ifplugin.conf"),
    52  		)
    53  	}
    54  
    55  	return p
    56  }
    57  
    58  // Option is a function that can be used in NewPlugin to customize Plugin.
    59  type Option func(*IfPlugin)
    60  
    61  // UseDeps returns Option that can inject custom dependencies.
    62  func UseDeps(f func(*Deps)) Option {
    63  	return func(p *IfPlugin) {
    64  		f(&p.Deps)
    65  	}
    66  }