Skip to content

renaming vsi -> endpoint #676

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 8, 2024
Merged

renaming vsi -> endpoint #676

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e841bdd
renaming
ShiriMoran Jul 8, 2024
899b352
renaming
ShiriMoran Jul 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 32 additions & 33 deletions pkg/vpcmodel/explainabilityInput.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ const noValidInputMsg = "is not a legal IP address, CIDR, or endpoint name"

const deliminator = "/"

// was src/dst input provided as internal address of a vsi? this is required info since
// if this is the case then in the output the relevant detected VSIs' names are printed
// was src/dst input provided as internal address of an endpoint? this is required info since
// if this is the case then in the output the relevant detected endpoints' names are printed
type srcDstInternalAddr struct {
src bool
dst bool
Expand All @@ -62,8 +62,8 @@ type srcAndDstNodes struct {

// getVPCConfigAndSrcDstNodes given src, dst in string returns the config in which the exaplainability analysis of these
// should be done and the Nodes for src and dst. It also returns whether src and/or dst was given as the internal address of
// a vsi - which effects the output.
// src/dst when referring to a vsi *name* may be prefixed with the vpc name with the deliminator "/" to solve ambiguity
// an endpoint - which effects the output.
// src/dst when referring to an endpoint *name* may be prefixed with the vpc name with the deliminator "/" to solve ambiguity
// If such prefix is missing then a match in any vpc is valid.
// At most one config should contain both src and dst, and this is the config returned:
// * If one is internal and the other is external the vpcConfig of the internal is returned
Expand All @@ -73,7 +73,7 @@ type srcAndDstNodes struct {
// this is the vpcConfig that will be returned, if such tgw exists; if such a tgw does not exist the src and dst are not connected
// At this stage, we do not support the following:
// 1. two tgw connects src and dst;
// 2. src and/or dst has VSI(s) in more than one VPC
// 2. src and/or dst has endpoint(s) in more than one VPC

// error handling: the src and dst are being searched for within the context of each vpcConfig.
// if no match found, then it is due to one of the following errors:
Expand All @@ -92,12 +92,12 @@ type srcAndDstNodes struct {
//
// More than one match found is also considered an error. It can be due to one of the following:
// 1. src and dst are of different VPCs and are connected by more than one tgw
// 2. src and dst are internal address containing VSIs in more than one VPC
// 3. src (dst) is internal containing VSIs in more than one VPC and dst (src) is external
// 2. src and dst are internal address containing endpoints in more than one VPC
// 3. src (dst) is internal containing endpoints in more than one VPC and dst (src) is external
// neither are supported in this stage
// todo: note that there could be cases in which src/dst are internal address that contains EPs of more than one VPC
// which will not result in an error. E.g., src is a vsi of VPC1 and dst is an internal address of VPC1 and VPC2.
// in this case explainability analysis will be done for VPC1
// which will not result in an error. E.g., src is a endpoint of VPC1 and dst is an internal address of VPC1
// and VPC2. in this case explainability analysis will be done for VPC1

//nolint:gocyclo // better not split into two function
func (c *MultipleVPCConfigs) getVPCConfigAndSrcDstNodes(src, dst string) (vpcConfig *VPCConfig,
Expand Down Expand Up @@ -215,7 +215,7 @@ func (c *MultipleVPCConfigs) listNamesCfg(configsWithSrcDstNode map[string]srcAn
i := 0
matchConfigs := make([]string, len(configsWithSrcDstNode))
for vpcUID := range configsWithSrcDstNode {
// the vsis are in more than one config; lists all the configs it is in for the error msg
// the endpoints are in more than one config; lists all the configs it is in for the error msg
matchConfigs[i] = c.Config(vpcUID).VPC.Name()
i++
}
Expand Down Expand Up @@ -261,8 +261,8 @@ func (e *ExplanationArgs) GetConnectionSet() *connection.Set {

// given src and dst input and a VPCConfigs finds the []nodes they represent in the config
// src/dst may refer to:
// 1. VSI by UID or name; in this case we consider the network interfaces of the VSI
// 2. Internal IP address or cidr; in this case we consider the VSIs in that address range
// 1. Endpoint by UID or name; in this case we consider the network interfaces of the endpoint
// 2. Internal IP address or cidr; in this case we consider the endpoints in that address range
// 3. external IP address or cidr
func (c *VPCConfig) srcDstInputToNodes(srcName, dstName string) (srcNodes,
dstNodes []Node, isSrcDstInternalIP srcDstInternalAddr, errType int, err error) {
Expand Down Expand Up @@ -292,7 +292,7 @@ func (c *VPCConfig) srcDstInputToNodes(srcName, dstName string) (srcNodes,
return srcNodes, dstNodes, srcDstInternalAddr{isSrcInternalIP, isDstInternalIP}, noErr, nil
}

// given a VPCConfig and a string looks for the VSI/Internal IP/External address it presents,
// given a VPCConfig and a string looks for the endpoint/Internal IP/External address it presents,
// as described above
func (c *VPCConfig) getSrcOrDstInputNode(name, srcOrDst string) (nodes []Node,
internalIP bool, errType int, err error) {
Expand All @@ -303,18 +303,18 @@ func (c *VPCConfig) getSrcOrDstInputNode(name, srcOrDst string) (nodes []Node,
return outNodes, isInternalIP, noErr, nil
}

// given a VPCConfig and a string cidrOrName representing a vsi or internal/external
// given a VPCConfig and a string cidrOrName representing an endpoint or internal/external
// cidr/address returns the corresponding node(s) and a bool which is true iff
// cidrOrName is an internal address and the nodes are its network interfaces
func (c *VPCConfig) getNodesFromInputString(cidrOrName string) (nodes []Node,
internalIP bool, errType int, err error) {
// 1. cidrOrName references vsi
vsi, errType1, err1 := c.getNodesOfVsi(cidrOrName)
// 1. cidrOrName references endpoint
endpoint, errType1, err1 := c.getNodesOfEndpoint(cidrOrName)
if err1 != nil {
return nil, false, errType1, err1
}
if vsi != nil {
return vsi, false, noErr, nil
if endpoint != nil {
return endpoint, false, noErr, nil
}
// cidrOrName, if legal, references an address.
// 2. cidrOrName references an ip address
Expand All @@ -329,37 +329,36 @@ func (c *VPCConfig) getNodesFromInputString(cidrOrName string) (nodes []Node,
return c.getNodesFromAddress(cidrOrName, ipBlock)
}

// getNodesOfVsi gets a string name or UID of VSI, and
// returns the list of all nodes within this vsi
func (c *VPCConfig) getNodesOfVsi(name string) ([]Node, int, error) {
var nodeSetWithVsi NodeSet
// vsi name may be prefixed by vpc name
var vpc, vsi string
// getNodesOfEndpoint gets a string name or UID of an endpoint (e.g. VSI), and
// returns the list of all nodes within this endpoint
func (c *VPCConfig) getNodesOfEndpoint(name string) ([]Node, int, error) {
var nodeSetOfEndpoint NodeSet
// endpoint name may be prefixed by vpc name
var vpc, endpoint string
uid := name // uid specified - vpc prefix is not relevant and uid may contain the deliminator "/"
cidrOrNameSlice := strings.Split(name, deliminator)
switch len(cidrOrNameSlice) {
case 1: // vpc name not specified
vsi = name
endpoint = name
case 2: // vpc name specified
vpc = cidrOrNameSlice[0]
vsi = cidrOrNameSlice[1]
endpoint = cidrOrNameSlice[1]
}
for _, nodeSet := range c.NodeSets {
// currently, assuming c.NodeSets consists of VSIs or VPE
if (vpc == "" || nodeSet.VPC().Name() == vpc) && nodeSet.Name() == vsi || // if vpc of vsi specified, equality must hold
if (vpc == "" || nodeSet.VPC().Name() == vpc) && nodeSet.Name() == endpoint || // if vpc of endpoint specified, equality must hold
nodeSet.UID() == uid {
if nodeSetWithVsi != nil {
if nodeSetOfEndpoint != nil {
return nil, fatalErr, fmt.Errorf("ambiguity - the configuration contains multiple resources named %s, "+
"try using CRNs or the VPC name to scope resources: vpc-name/instance-name"+
"\nCRNs of matching resources:\n\t%s\n\t%s", name, nodeSetWithVsi.UID(), nodeSet.UID())
"\nCRNs of matching resources:\n\t%s\n\t%s", name, nodeSetOfEndpoint.UID(), nodeSet.UID())
}
nodeSetWithVsi = nodeSet
nodeSetOfEndpoint = nodeSet
}
}
if nodeSetWithVsi == nil {
if nodeSetOfEndpoint == nil {
return nil, noErr, nil
}
return nodeSetWithVsi.Nodes(), noErr, nil
return nodeSetOfEndpoint.Nodes(), noErr, nil
}

// getNodesFromAddress gets a string and IPBlock that represents a cidr or IP address
Expand Down