controllers

Documentation

Index

• Constants
• type ConfigMapOperator
  • func (cmo *ConfigMapOperator) CreateOrUpdate(ctx context.Context, oathkeeperRulesJSON []byte, ...) error
• type FilesOperator
  • func (fo *FilesOperator) CreateOrUpdate(ctx context.Context, oathkeeperRulesJSON []byte, ...) error
• type OperatorMode
• type RuleReconciler
  • func (r *RuleReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error)
  • func (r *RuleReconciler) SetupWithManager(mgr ctrl.Manager) error

Constants

const (

	// FinalizerName name of the finalier
	FinalizerName = "finalizer.oathkeeper.ory.sh"
)

Types

type ConfigMapOperator

type ConfigMapOperator struct {
	client.Client
	Log              logr.Logger
	DefaultConfigMap types.NamespacedName
	RulesFileName    string
}

ConfigMapOperator that maintains Oathkeeper rules as an json-formatted entry in a ConfigMap

func (*ConfigMapOperator) CreateOrUpdate

func (cmo *ConfigMapOperator) CreateOrUpdate(ctx context.Context, oathkeeperRulesJSON []byte, triggeredBy *oathkeeperv1alpha1.Rule) error

type FilesOperator

type FilesOperator struct {
	Log           logr.Logger
	RulesFilePath string
}

FilesOperator that maintains Oathkeeper rules as a flat json file in a local filesystem

func (*FilesOperator) CreateOrUpdate

func (fo *FilesOperator) CreateOrUpdate(ctx context.Context, oathkeeperRulesJSON []byte, triggeredBy *oathkeeperv1alpha1.Rule) error

type OperatorMode

type OperatorMode interface {
	// CreateOrUpdate ORY Oathkeeper Access Rule list using implementation-specific means.
	// oathkeeperRulesJSON - serialized JSON with an array of objects that conform to Oathkeeper Rule syntax
	// triggeredBy - the recently created/update rule that triggered the operation
	CreateOrUpdate(ctx context.Context, oathkeeperRulesJSON []byte, triggeredBy *oathkeeperv1alpha1.Rule) error
}

OperatorMode is an interface that provides runtime strategy for operating mode ("controller" or "sidecar").

type RuleReconciler

type RuleReconciler struct {
	client.Client
	Log              logr.Logger
	ValidationConfig validation.Config
	OperatorMode
}

RuleReconciler reconciles a Rule object

func (*RuleReconciler) Reconcile

func (r *RuleReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error)

Reconcile main reconcile loop

func (*RuleReconciler) SetupWithManager

func (r *RuleReconciler) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager ??