types.go

/*-
 * Copyright (c) 2016-2019, F5 Networks, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package appmanager

type (
	// Configs for each BIG-IP partition
	PartitionMap map[string]*BigIPConfig

	// Config of all resources to configure on the BIG-IP
	BigIPConfig struct {
		Virtuals           Virtuals            `json:"virtualServers,omitempty"`
		Pools              Pools               `json:"pools,omitempty"`
		Monitors           Monitors            `json:"monitors,omitempty"`
		Policies           []Policy            `json:"l7Policies,omitempty"`
		CustomProfiles     []CustomProfile     `json:"customProfiles,omitempty"`
		IRules             []IRule             `json:"iRules,omitempty"`
		InternalDataGroups []InternalDataGroup `json:"internalDataGroups,omitempty"`
		IApps              []IApp              `json:"iapps,omitempty"`
	}

	// Config for a single resource (ConfigMap, Ingress, or Route)
	ResourceConfig struct {
		MetaData metaData `json:"-"`
		Virtual  Virtual  `json:"virtual,omitempty"`
		IApp     IApp     `json:"iapp,omitempty"`
		Pools    Pools    `json:"pools,omitempty"`
		Monitors Monitors `json:"monitors,omitempty"`
		Policies Policies `json:"policies,omitempty"`
	}
	ResourceConfigs []*ResourceConfig

	metaData struct {
		Active       bool
		ResourceType string
		// Only used for Routes (for keeping track of annotated profiles)
		RouteProfs map[routeKey]string
		// Name of the Ingress that created this config
		// Used to prevent single-service Ingresses from sharing virtuals
		ingName string
	}

	// Key used to store annotated profiles for a route
	routeKey struct {
		Name      string
		Namespace string
		Context   string
	}

	// Reference to pre-existing profiles
	ProfileRef struct {
		Name      string `json:"name"`
		Partition string `json:"partition"`
		Context   string `json:"context"` // 'clientside', 'serverside', or 'all'
		// Used as reference to which Namespace/Ingress this profile came from
		// (for deletion purposes)
		Namespace string `json:"-"`
	}
	ProfileRefs []ProfileRef

	// Virtual server config
	Virtual struct {
		Name                  string                `json:"name"`
		PoolName              string                `json:"pool,omitempty"`
		Partition             string                `json:"-"`
		Destination           string                `json:"destination"`
		Enabled               bool                  `json:"enabled"`
		IpProtocol            string                `json:"ipProtocol,omitempty"`
		SourceAddrTranslation SourceAddrTranslation `json:"sourceAddressTranslation,omitempty"`
		Policies              []nameRef             `json:"policies,omitempty"`
		IRules                []string              `json:"rules,omitempty"`
		Profiles              ProfileRefs           `json:"profiles,omitempty"`
		Description           string                `json:"description,omitempty"`
		VirtualAddress        *virtualAddress       `json:"-"`
	}
	Virtuals []Virtual

	// IApp
	IApp struct {
		Name                string                    `json:"name"`
		Partition           string                    `json:"-"`
		IApp                string                    `json:"template"`
		IAppPoolMemberTable *iappPoolMemberTable      `json:"poolMemberTable,omitempty"`
		IAppOptions         map[string]string         `json:"options,omitempty"`
		IAppTables          map[string]iappTableEntry `json:"tables,omitempty"`
		IAppVariables       map[string]string         `json:"variables,omitempty"`
	}

	// Pool Member
	Member struct {
		Address string `json:"address"`
		Port    int32  `json:"port"`
		Session string `json:"session,omitempty"`
	}

	// Pool config
	Pool struct {
		Name         string   `json:"name"`
		Partition    string   `json:"-"`
		ServiceName  string   `json:"-"`
		ServicePort  int32    `json:"-"`
		Balance      string   `json:"loadBalancingMode"`
		Members      []Member `json:"members"`
		MonitorNames []string `json:"monitors,omitempty"`
	}
	Pools []Pool

	// Pool health monitor
	Monitor struct {
		Name      string `json:"name"`
		Partition string `json:"-"`
		Interval  int    `json:"interval,omitempty"`
		Type      string `json:"type,omitempty"`
		Send      string `json:"send,omitempty"`
		Recv      string `json:"recv,omitempty"`
		Timeout   int    `json:"timeout,omitempty"`
	}
	Monitors []Monitor

	// Virtual Server Source Address Translation
	SourceAddrTranslation struct {
		Type string `json:"type"`
		Pool string `json:"pool,omitempty"`
	}

	// Virtual policy
	Policy struct {
		Name        string   `json:"name"`
		Partition   string   `json:"-"`
		SubPath     string   `json:"subPath,omitempty"`
		Controls    []string `json:"controls,omitempty"`
		Description string   `json:"description,omitempty"`
		Legacy      bool     `json:"legacy,omitempty"`
		Requires    []string `json:"requires,omitempty"`
		Rules       Rules    `json:"rules,omitempty"`
		Strategy    string   `json:"strategy,omitempty"`
	}
	Policies []Policy

	// Rule config for a Policy
	Rule struct {
		Name       string       `json:"name"`
		FullURI    string       `json:"-"`
		Ordinal    int          `json:"ordinal,omitempty"`
		Actions    []*action    `json:"actions,omitempty"`
		Conditions []*condition `json:"conditions,omitempty"`
	}

	// action config for a Rule
	action struct {
		Name      string `json:"name"`
		Pool      string `json:"pool,omitempty"`
		HTTPHost  bool   `json:"httpHost,omitempty"`
		HttpReply bool   `json:"httpReply,omitempty"`
		HTTPURI   bool   `json:"httpUri,omitempty"`
		Forward   bool   `json:"forward,omitempty"`
		Location  string `json:"location,omitempty"`
		Path      string `json:"path,omitempty"`
		Redirect  bool   `json:"redirect,omitempty"`
		Replace   bool   `json:"replace,omitempty"`
		Request   bool   `json:"request,omitempty"`
		Reset     bool   `json:"reset,omitempty"`
		Select    bool   `json:"select,omitempty"`
		Value     string `json:"value,omitempty"`
	}

	// condition config for a Rule
	condition struct {
		Name            string   `json:"name"`
		Address         bool     `json:"address,omitempty"`
		CaseInsensitive bool     `json:"caseInsensitive,omitempty"`
		Equals          bool     `json:"equals,omitempty"`
		EndsWith        bool     `json:"endsWith,omitempty"`
		External        bool     `json:"external,omitempty"`
		HTTPHost        bool     `json:"httpHost,omitempty"`
		Host            bool     `json:"host,omitempty"`
		HTTPURI         bool     `json:"httpUri,omitempty"`
		Index           int      `json:"index,omitempty"`
		Matches         bool     `json:"matches,omitempty"`
		Path            bool     `json:"path,omitempty"`
		PathSegment     bool     `json:"pathSegment,omitempty"`
		Present         bool     `json:"present,omitempty"`
		Remote          bool     `json:"remote,omitempty"`
		Request         bool     `json:"request,omitempty"`
		Scheme          bool     `json:"scheme,omitempty"`
		Tcp             bool     `json:"tcp,omitempty"`
		Values          []string `json:"values"`
	}

	Rules   []*Rule
	ruleMap map[string]*Rule

	// virtual server policy/profile reference
	nameRef struct {
		Name      string `json:"name"`
		Partition string `json:"partition"`
	}

	// frontend bindaddr and port
	virtualAddress struct {
		BindAddr string `json:"bindAddr,omitempty"`
		Port     int32  `json:"port,omitempty"`
	}

	// frontend ssl profile
	sslProfile struct {
		F5ProfileName  string   `json:"f5ProfileName,omitempty"`
		F5ProfileNames []string `json:"f5ProfileNames,omitempty"`
	}

	// frontend pool member column definition
	iappPoolMemberColumn struct {
		Name  string `json:"name"`
		Kind  string `json:"kind,omitempty"`
		Value string `json:"value,omitempty"`
	}

	// frontend pool member table
	iappPoolMemberTable struct {
		Name    string                 `json:"name"`
		Columns []iappPoolMemberColumn `json:"columns"`
		Members []Member               `json:"members,omitempty"`
	}

	// frontend iapp table entry
	iappTableEntry struct {
		Columns []string   `json:"columns,omitempty"`
		Rows    [][]string `json:"rows,omitempty"`
	}

	// SSL Profile loaded from Secret or Route object
	CustomProfile struct {
		Name         string `json:"name"`
		Partition    string `json:"-"`
		Context      string `json:"context"` // 'clientside', 'serverside', or 'all'
		Cert         string `json:"cert"`
		Key          string `json:"key"`
		ServerName   string `json:"serverName,omitempty"`
		SNIDefault   bool   `json:"sniDefault,omitempty"`
		PeerCertMode string `json:"peerCertMode,omitempty"`
		CAFile       string `json:"caFile,omitempty"`
	}

	// Used to unmarshal ConfigMap data
	ConfigMap struct {
		VirtualServer struct {
			Backend  configMapBackend  `json:"backend"`
			Frontend configMapFrontend `json:"frontend"`
		} `json:"virtualServer"`
	}

	configMapMonitor struct {
		Name      string `json:"name"`
		Partition string `json:"partition,omitempty"`
		Interval  int    `json:"interval,omitempty"`
		Protocol  string `json:"protocol,omitempty"`
		Send      string `json:"send,omitempty"`
		Recv      string `json:"recv,omitempty"`
		Timeout   int    `json:"timeout,omitempty"`
	}

	configMapBackend struct {
		ServiceName     string             `json:"serviceName"`
		ServicePort     int32              `json:"servicePort"`
		PoolMemberAddrs []string           `json:"poolMemberAddrs"`
		HealthMonitors  []configMapMonitor `json:"healthMonitors,omitempty"`
	}

	configMapFrontend struct {
		Name     string `json:"name"`
		PoolName string `json:"pool,omitempty"`
		// Mutual parameter, partition
		Partition string `json:"partition,omitempty"`

		// VirtualServer parameters
		Balance               string                `json:"balance,omitempty"`
		Mode                  string                `json:"mode,omitempty"`
		VirtualAddress        *virtualAddress       `json:"virtualAddress,omitempty"`
		Destination           string                `json:"destination,omitempty"`
		Enabled               bool                  `json:"enabled,omitempty"`
		IpProtocol            string                `json:"ipProtocol,omitempty"`
		SourceAddrTranslation SourceAddrTranslation `json:"sourceAddressTranslation,omitempty"`
		SslProfile            *sslProfile           `json:"sslProfile,omitempty"`
		Policies              []nameRef             `json:"policies,omitempty"`
		IRules                []string              `json:"rules,omitempty"`
		Profiles              ProfileRefs           `json:"profiles,omitempty"`

		// iApp parameters
		IApp                string                    `json:"iapp,omitempty"`
		IAppPoolMemberTable *iappPoolMemberTable      `json:"iappPoolMemberTable,omitempty"`
		IAppOptions         map[string]string         `json:"iappOptions,omitempty"`
		IAppTables          map[string]iappTableEntry `json:"iappTables,omitempty"`
		IAppVariables       map[string]string         `json:"iappVariables,omitempty"`
	}

	// This is the format for each item in the health monitor annotation used
	// in the Ingress and Route objects.
	AnnotationHealthMonitor struct {
		Path     string `json:"path"`
		Interval int    `json:"interval"`
		Send     string `json:"send"`
		Recv     string `json:"recv"`
		Timeout  int    `json:"timeout"`
		Type     string `json:"type"`
	}
	AnnotationHealthMonitors []AnnotationHealthMonitor

	ruleData struct {
		svcName   string
		svcPort   int32
		healthMon AnnotationHealthMonitor
		assigned  bool
	}
	pathToRuleMap map[string]*ruleData
	hostToPathMap map[string]pathToRuleMap

	// Virtual Server Key - unique server is Name + Port
	serviceKey struct {
		ServiceName string
		ServicePort int32
		Namespace   string
	}

	// iRules
	IRule struct {
		Name      string `json:"name"`
		Partition string `json:"-"`
		Code      string `json:"apiAnonymous"`
	}

	IRulesMap map[nameRef]*IRule

	InternalDataGroup struct {
		Name      string                   `json:"name"`
		Partition string                   `json:"-"`
		Records   InternalDataGroupRecords `json:"records"`
	}

	InternalDataGroupRecord struct {
		Name string `json:"name"`
		Data string `json:"data"`
	}
	InternalDataGroupRecords []InternalDataGroupRecord

	DataGroupNamespaceMap map[string]*InternalDataGroup
	InternalDataGroupMap  map[nameRef]DataGroupNamespaceMap

	// AS3 Backend supported features
	virtuals int

	// Routes annotation features that are possible by an AS3 declaration can be added here. Initially enabling a WAF
	// policy is added as an AS3 feature.
	// | Host + Path | Virtual Server to Apply | WAF Policy Name |
	// |-------------|-------------------------|-----------------|
	// Host + Path is a unique record. The columns can be extended to add future features.
	// InternalF5ResourcesGroup takes OpenShift/Kubernetes namespace as key
	InternalF5ResourcesGroup map[string]InternalF5Resources
	InternalF5Resources      map[Record]F5Resources

	Record struct {
		Host string
		Path string
	}

	F5Resources struct {
		Virtual   virtuals // 0 - HTTP, 1 - HTTPS, 2 - HTTP/S
		WAFPolicy string
	}
)

// Determines which virtual server needs a specific feature applied.
const (
	HTTP virtuals = iota
	HTTPS
	HTTPANDS
)