policy

Documentation

Index

• type Actions
  • func NewActions() Actions
• type CrdKey
• type Endpoint
• type Method
  • func NewMethod(method string) Method
  • func (m Method) String() string
• type PolicyMapping
  • func NewPolicyMapping(service Endpoint, actions []v1.PathPolicy) PolicyMapping
• type RoutePolicy
  • func NewRoutePolicy() RoutePolicy
• type Service
• type Type
  • func NewType(t string) Type
  • func (t Type) String() string

Types

type Actions

type Actions = map[Method]RoutePolicy

func NewActions

func NewActions() Actions

New creates a new Actions

type CrdKey

type CrdKey struct {
	Id      string
	CrdType v1.CrdType
}

CrdKey represents a CustomResourceDefinition ID

type Endpoint

type Endpoint struct {
	Service Service
	// Path holds a url path string
	Path string
	// Method holds an HTTP Method
	Method Method
}

Endpoint captures a request endpoint

type Method

type Method int

const (
	ALL Method = iota
	GET
	PUT
	POST
	DELETE
	PATCH
)

func NewMethod

func NewMethod(method string) Method

func (Method) String

func (m Method) String() string

type PolicyMapping

type PolicyMapping struct {
	Actions  []v1.PathPolicy
	Endpoint Endpoint
}

PolicyMapping captures information of created endpoints by policy

func NewPolicyMapping

func NewPolicyMapping(service Endpoint, actions []v1.PathPolicy) PolicyMapping

New creates a new ParsedPolicies

type RoutePolicy

type RoutePolicy struct {
	PolicyReference string
	Actions         []v1.PathPolicy
}

func NewRoutePolicy

func NewRoutePolicy() RoutePolicy

type Service

type Service struct {
	// Namespace is the group the service lives in
	Namespace string
	// Name is the name of the service
	Name string
}

Service identifies a Kubernetes service

type Type

type Type int

Type represents a policy types (WEB/API)

const (
	// JWT policy types specifies requests protected by API strategy
	JWT Type = iota
	// OIDC policy types specifies requests protected by WEB strategy
	OIDC
	// NONE policy specifies requests without protection
	NONE
)

func NewType

func NewType(t string) Type

func (Type) String

func (t Type) String() string