qpoption

README

Queue Proxy Option

This package includes glue code needed to attach a security plug such as:

• guard-gate
• test-gate

as an option (extension) to Knative queue.

The package reads the service annotations from annotations file in the podInfo volume mounted by Queue Proxy. The annotations indicate if the security plug need to be activated and provide config parameters to the security plug.

The package then interact with the pluginterfaces package and the respective security gate to ensure they are properly initialized and may start serving the requests, responses and global queue proxy context.

Using Plugs

This package enables using security plugs with Queue Proxy by following these steps:

1. Replace cmd/queue/main.go of serving with the code as described below.
2. Create a new Queue Proxy Image
3. Store the new Queue Proxy Image in an image repository
4. Configure your cluster to use the new Queue Proxy Image

In order to activate guard-gate replace cmd/queue/main.go of serving with the following code:

package main

import "os"

import (
    "knative.dev/serving/pkg/queue/sharedmain"
    "github.com/knative-sandbox/security-guard/pkg/qpoption"
    _ "github.com/knative-sandbox/security-guard/pkg/guard-gate"
)

func main() {
    qOpt := qpoption.NewGateQPOption()
    defer qOpt.Shutdown()
    
    if sharedmain.Main(qOpt.Setup) != nil {
      qOpt.Shutdown()
      os.Exit(1)
    }
} 

In order to activate test-gate replace cmd/queue/main.go of serving with the following code:

package main

import "os"

import (
    "knative.dev/serving/pkg/queue/sharedmain"
    "github.com/knative-sandbox/security-guard/pkg/qpoption"
    _ "github.com/knative-sandbox/security-guard/pkg/test-gate"
)

func main() {
    qOpt := qpoption.NewGateQPOption()
    defer qOpt.Shutdown()
    
    if sharedmain.Main(qOpt.Setup) != nil {
      qOpt.Shutdown()
      os.Exit(1)
    }
} 

Documentation

Index

• type GateQPOption
  • func NewGateQPOption() *GateQPOption
  • func (p *GateQPOption) ProcessAnnotations() bool
  • func (p *GateQPOption) RoundTrip(req *http.Request) (resp *http.Response, err error)
  • func (p *GateQPOption) Setup(defaults *sharedmain.Defaults)
  • func (p *GateQPOption) Shutdown()

Types

type GateQPOption

type GateQPOption struct {
	// contains filtered or unexported fields
}

func NewGateQPOption

func NewGateQPOption() *GateQPOption

func (*GateQPOption) ProcessAnnotations

func (p *GateQPOption) ProcessAnnotations() bool

func (*GateQPOption) RoundTrip

func (p *GateQPOption) RoundTrip(req *http.Request) (resp *http.Response, err error)

func (*GateQPOption) Setup

func (p *GateQPOption) Setup(defaults *sharedmain.Defaults)

func (*GateQPOption) Shutdown

func (p *GateQPOption) Shutdown()