tracingpolicy

Documentation

Index

• type GenericTracingPolicy
  • func (gtp *GenericTracingPolicy) TpInfo() string
  • func (gtp *GenericTracingPolicy) TpName() string
  • func (gtp *GenericTracingPolicy) TpSpec() *v1alpha1.TracingPolicySpec
• type GenericTracingPolicyNamespaced
  • func (gtp *GenericTracingPolicyNamespaced) TpInfo() string
  • func (gtp *GenericTracingPolicyNamespaced) TpName() string
  • func (gtp *GenericTracingPolicyNamespaced) TpNamespace() string
  • func (gtp *GenericTracingPolicyNamespaced) TpSpec() *v1alpha1.TracingPolicySpec
• type Metadata
• type MetadataNamespaced
• type PolicyEvent
• type PolicyInfo
• type TracingPolicy
  • func NamespacedPolicyFromYAML(data string) (TracingPolicy, error)
  • func PolicyFromYAML(data string) (TracingPolicy, error)
  • func PolicyFromYAMLFilename(fileName string) (TracingPolicy, error)
• type TracingPolicyNamespaced

Types

type GenericTracingPolicy

type GenericTracingPolicy struct {
	ApiVersion string                     `json:"apiVersion"`
	Kind       string                     `json:"kind"`
	Metadata   Metadata                   `json:"metadata"`
	Spec       v1alpha1.TracingPolicySpec `json:"spec"`
}

func (*GenericTracingPolicy) TpInfo

func (gtp *GenericTracingPolicy) TpInfo() string

func (*GenericTracingPolicy) TpName

func (gtp *GenericTracingPolicy) TpName() string

func (*GenericTracingPolicy) TpSpec

func (gtp *GenericTracingPolicy) TpSpec() *v1alpha1.TracingPolicySpec

type GenericTracingPolicyNamespaced

type GenericTracingPolicyNamespaced struct {
	ApiVersion string                     `json:"apiVersion"`
	Kind       string                     `json:"kind"`
	Metadata   MetadataNamespaced         `json:"metadata"`
	Spec       v1alpha1.TracingPolicySpec `json:"spec"`
}

func (*GenericTracingPolicyNamespaced) TpInfo

func (gtp *GenericTracingPolicyNamespaced) TpInfo() string

func (*GenericTracingPolicyNamespaced) TpName

func (gtp *GenericTracingPolicyNamespaced) TpName() string

func (*GenericTracingPolicyNamespaced) TpNamespace

func (gtp *GenericTracingPolicyNamespaced) TpNamespace() string

func (*GenericTracingPolicyNamespaced) TpSpec

func (gtp *GenericTracingPolicyNamespaced) TpSpec() *v1alpha1.TracingPolicySpec

type Metadata

type Metadata struct {
	Name string `yaml:"name"`
}

type MetadataNamespaced

type MetadataNamespaced struct {
	Name      string `yaml:"name"`
	Namespace string `yaml:"namespace"`
}

type PolicyEvent

type PolicyEvent interface {
	PolicyInfo() PolicyInfo
}

type PolicyInfo

type PolicyInfo struct {
	Name string
	Hook string
}

type TracingPolicy

type TracingPolicy interface {
	// TpName returns the name of the policy.
	TpName() string
	// TpSpec  returns the specification of the policy
	TpSpec() *v1alpha1.TracingPolicySpec
	// TpInfo returns a description of the policy
	TpInfo() string
}

TracingPolicy is a tracing policy interface. It is implemented by v1alpha1.types.TracingPolicy and config.GenericTracingConf. The former is what is the k8s API server uses, and the latter is used when we load files directly (e.g., via the cli).

func NamespacedPolicyFromYAML

func NamespacedPolicyFromYAML(data string) (TracingPolicy, error)

func PolicyFromYAML

func PolicyFromYAML(data string) (TracingPolicy, error)

func PolicyFromYAMLFilename

func PolicyFromYAMLFilename(fileName string) (TracingPolicy, error)

type TracingPolicyNamespaced

type TracingPolicyNamespaced interface {
	TracingPolicy
	// TpNamespace returns the namespace of the policy
	TpNamespace() string
}

TracingPolicyNamespaced is an interface for tracing policy applied on a specific namespace