policy_client

README

Policy Client

Policy Client allows Cloud Foundry system components to query the policy server for policies. It is currently used by the VXLAN policy agent (in silk-release) and copilot.

Getting Help

For help or questions about this component, you can reach the maintainers on Slack at cloudfoundry.slack.com in the #networking channel.

Documentation

Index

• Constants
• type Chunker
• type Destination
• type DestinationV0
• type EgressDestination
• type EgressPolicy
• type EgressPolicySlice
  • func (s EgressPolicySlice) Len() int
  • func (s EgressPolicySlice) Less(i, j int) bool
  • func (s EgressPolicySlice) Swap(i, j int)
• type EgressSource
• type IPRange
• type InternalClient
  • func NewInternal(logger lager.Logger, httpClient json_client.HttpClient, baseURL string) *InternalClient
  • func (c *InternalClient) CreateOrGetTag(id, groupType string) (string, error)
  • func (c *InternalClient) GetPolicies() ([]*Policy, []*EgressPolicy, error)
  • func (c *InternalClient) GetPoliciesByID(ids ...string) ([]Policy, []EgressPolicy, error)
  • func (c *InternalClient) HealthCheck() (bool, error)
• type InternalPolicyClient
• type Policies
• type PoliciesV0
• type Policy
• type PolicySlice
  • func (s PolicySlice) Len() int
  • func (s PolicySlice) Less(i, j int) bool
  • func (s PolicySlice) Swap(i, j int)
• type PolicyV0
• type Ports
• type SimpleChunker
  • func (c *SimpleChunker) Chunk(allPolicies []PolicyV0) [][]PolicyV0
• type Source
• type SourceV0
• type Space
• type SpaceV0
• type Tag
• type TagRequest
• type TagV0

Constants

const DefaultMaxPolicies = 100

Types

type Chunker

type Chunker interface {
	Chunk(allPolicies []PolicyV0) [][]PolicyV0
}

type Destination

type Destination struct {
	ID       string `json:"id"`
	Tag      string `json:"tag,omitempty"`
	Protocol string `json:"protocol"`
	Ports    Ports  `json:"ports"`
}

type DestinationV0

type DestinationV0 struct {
	ID       string `json:"id"`
	Tag      string `json:"tag,omitempty"`
	Protocol string `json:"protocol"`
	Port     int    `json:"port"`
}

type EgressDestination

type EgressDestination struct {
	Protocol string    `json:"protocol"`
	Ports    []Ports   `json:"ports"`
	IPRanges []IPRange `json:"ips"`
	ICMPType int       `json:"icmp_type"`
	ICMPCode int       `json:"icmp_code"`
}

type EgressPolicy

type EgressPolicy struct {
	Source       *EgressSource      `json:"source"`
	Destination  *EgressDestination `json:"destination"`
	AppLifecycle string             `json:"app_lifecycle"`
}

type EgressPolicySlice

type EgressPolicySlice []EgressPolicy

func (EgressPolicySlice) Len

func (s EgressPolicySlice) Len() int

func (EgressPolicySlice) Less

func (s EgressPolicySlice) Less(i, j int) bool

func (EgressPolicySlice) Swap

func (s EgressPolicySlice) Swap(i, j int)

type EgressSource

type EgressSource struct {
	ID   string `json:"id"`
	Type string `json:"type"`
}

type IPRange

type IPRange struct {
	Start string `json:"start"`
	End   string `json:"end"`
}

type InternalClient

type InternalClient struct {
	JsonClient json_client.JsonClient
}

func NewInternal

func NewInternal(logger lager.Logger, httpClient json_client.HttpClient, baseURL string) *InternalClient

func (*InternalClient) CreateOrGetTag

func (c *InternalClient) CreateOrGetTag(id, groupType string) (string, error)

func (*InternalClient) GetPolicies

func (c *InternalClient) GetPolicies() ([]*Policy, []*EgressPolicy, error)

func (*InternalClient) GetPoliciesByID

func (c *InternalClient) GetPoliciesByID(ids ...string) ([]Policy, []EgressPolicy, error)

func (*InternalClient) HealthCheck

func (c *InternalClient) HealthCheck() (bool, error)

type InternalPolicyClient

type InternalPolicyClient interface {
	GetPolicies() ([]*Policy, []*EgressPolicy, error)
}

type Policies

type Policies struct {
	TotalPolicies int      `json:"total_policies"`
	Policies      []Policy `json:"policies"`
}

type PoliciesV0

type PoliciesV0 struct {
	TotalPolicies int        `json:"total_policies"`
	Policies      []PolicyV0 `json:"policies"`
}

type Policy

type Policy struct {
	Source      Source      `json:"source"`
	Destination Destination `json:"destination"`
}

type PolicySlice

type PolicySlice []Policy

func (PolicySlice) Len

func (s PolicySlice) Len() int

func (PolicySlice) Less

func (s PolicySlice) Less(i, j int) bool

func (PolicySlice) Swap

func (s PolicySlice) Swap(i, j int)

type PolicyV0

type PolicyV0 struct {
	Source      SourceV0      `json:"source"`
	Destination DestinationV0 `json:"destination"`
}

type Ports

type Ports struct {
	Start int `json:"start"`
	End   int `json:"end"`
}

type SimpleChunker

type SimpleChunker struct {
	ChunkSize int
}

func (*SimpleChunker) Chunk

func (c *SimpleChunker) Chunk(allPolicies []PolicyV0) [][]PolicyV0

type Source

type Source struct {
	ID  string `json:"id"`
	Tag string `json:"tag,omitempty"`
}

type SourceV0

type SourceV0 struct {
	ID  string `json:"id"`
	Tag string `json:"tag,omitempty"`
}

type Space

type Space struct {
	Name    string `json:"name"`
	OrgGUID string `json:"organization_guid"`
}

type SpaceV0

type SpaceV0 struct {
	Name    string `json:name`
	OrgGUID string `json:organization_guid`
}

type Tag

type Tag struct {
	ID  string `json:"id"`
	Tag string `json:"tag"`
}

type TagRequest

type TagRequest struct {
	ID   string
	Type string
}

type TagV0

type TagV0 struct {
	ID  string `json:"id"`
	Tag string `json:"tag"`
}