go.ligato.io/vpp-agent/v3@v3.5.0/proto/ligato/vpp/stn/models.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 vpp_stn
    16  
    17  import (
    18  	"go.ligato.io/vpp-agent/v3/pkg/models"
    19  )
    20  
    21  // ModuleName is the module name used for models.
    22  const ModuleName = "vpp.stn"
    23  
    24  var (
    25  	ModelRule = models.Register(&Rule{}, models.Spec{
    26  		Module:  ModuleName,
    27  		Type:    "rule",
    28  		Version: "v2",
    29  	}, models.WithNameTemplate("{{.Interface}}/ip/{{.IpAddress}}"))
    30  )
    31  
    32  // Key returns the prefix used in the ETCD to store a VPP STN config
    33  // of a particular STN rule in selected VPP instance.
    34  func Key(ifName, ipAddr string) string {
    35  	return models.Key(&Rule{
    36  		Interface: ifName,
    37  		IpAddress: ipAddr,
    38  	})
    39  }