Documentation
¶
Overview ¶
Package networkpolicy provides a builder and resource for managing Kubernetes NetworkPolicies.
Index ¶
- type Builder
- func (b *Builder) Build() (*Resource, error)
- func (b *Builder) WithDataExtractor(extractor func(networkingv1.NetworkPolicy) error) *Builder
- func (b *Builder) WithGuard(guard func(networkingv1.NetworkPolicy) (concepts.GuardStatusWithReason, error)) *Builder
- func (b *Builder) WithMutation(m Mutation) *Builder
- type Mutation
- type Mutator
- type Resource
- func (r *Resource) ExtractData() error
- func (r *Resource) GuardStatus() (concepts.GuardStatusWithReason, error)
- func (r *Resource) Identity() string
- func (r *Resource) Mutate(current client.Object) error
- func (r *Resource) Object() (client.Object, error)
- func (r *Resource) PreviewObject() (*networkingv1.NetworkPolicy, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Builder ¶
type Builder struct {
// contains filtered or unexported fields
}
Builder is a configuration helper for creating and customizing a NetworkPolicy Resource.
It provides a fluent API for registering mutations and data extractors. Build() validates the configuration and returns an initialized Resource ready for use in a reconciliation loop.
func NewBuilder ¶
func NewBuilder(np *networkingv1.NetworkPolicy) *Builder
NewBuilder initializes a new Builder with the provided NetworkPolicy object.
The NetworkPolicy object serves as the desired base state. During reconciliation the Resource will make the cluster's state match this base, modified by any registered mutations.
The provided NetworkPolicy must have both Name and Namespace set, which is validated during the Build() call.
func (*Builder) Build ¶
Build validates the configuration and returns the initialized Resource.
It returns an error if:
- No NetworkPolicy object was provided.
- The NetworkPolicy is missing a Name or Namespace.
func (*Builder) WithDataExtractor ¶
func (b *Builder) WithDataExtractor(extractor func(networkingv1.NetworkPolicy) error) *Builder
WithDataExtractor registers a function to read values from the NetworkPolicy after it has been successfully reconciled.
The extractor receives a value copy of the reconciled NetworkPolicy. This is useful for surfacing the applied policy rules to other components or resources.
A nil extractor is ignored.
func (*Builder) WithGuard ¶ added in v0.4.0
func (b *Builder) WithGuard(guard func(networkingv1.NetworkPolicy) (concepts.GuardStatusWithReason, error)) *Builder
WithGuard registers a guard precondition that is evaluated before the NetworkPolicy is applied during reconciliation. If the guard returns Blocked, the NetworkPolicy and all resources registered after it are skipped until the guard clears. Passing nil clears any previously registered guard.
func (*Builder) WithMutation ¶
WithMutation registers a mutation for the NetworkPolicy.
Mutations are applied sequentially during the Mutate() phase of reconciliation. A mutation with a nil Feature is applied unconditionally; one with a non-nil Feature is applied only when that feature is enabled.
type Mutation ¶
Mutation defines a mutation that is applied to a networkpolicy Mutator only if its associated feature gate is enabled.
type Mutator ¶
type Mutator struct {
// contains filtered or unexported fields
}
Mutator is a high-level helper for modifying a Kubernetes NetworkPolicy.
It uses a "plan-and-apply" pattern: mutations are recorded first, then applied to the NetworkPolicy in a single controlled pass when Apply() is called.
The Mutator maintains feature boundaries: each feature's mutations are planned together and applied in the order the features were registered.
Within a single feature plan, edits are applied in category order: metadata edits first, then spec edits. All edits within a category run in registration order.
Mutator implements editors.ObjectMutator.
func NewMutator ¶
func NewMutator(np *networkingv1.NetworkPolicy) *Mutator
NewMutator creates a new Mutator for the given NetworkPolicy.
It is typically used within a Feature's Mutation logic to express desired changes to the NetworkPolicy. The constructor creates the initial feature scope automatically.
func (*Mutator) Apply ¶
Apply executes all recorded mutation intents on the underlying NetworkPolicy.
Execution order across all registered features:
- Metadata edits (in registration order within each feature)
- Spec edits — EditNetworkPolicySpec (in registration order within each feature)
Features are applied in the order they were registered. Later features observe the NetworkPolicy as modified by all previous features.
func (*Mutator) EditNetworkPolicySpec ¶
func (m *Mutator) EditNetworkPolicySpec(edit func(*editors.NetworkPolicySpecEditor) error)
EditNetworkPolicySpec records a mutation for the NetworkPolicy's spec via a NetworkPolicySpecEditor.
The editor provides structured operations (SetPodSelector, AppendIngressRule, RemoveIngressRules, AppendEgressRule, RemoveEgressRules, SetPolicyTypes) as well as Raw() for free-form access. Spec edits are applied after metadata edits within the same feature, in registration order.
A nil edit function is ignored.
func (*Mutator) EditObjectMetadata ¶
func (m *Mutator) EditObjectMetadata(edit func(*editors.ObjectMetaEditor) error)
EditObjectMetadata records a mutation for the NetworkPolicy's own metadata.
Metadata edits are applied before spec edits within the same feature. A nil edit function is ignored.
func (*Mutator) NextFeature ¶
func (m *Mutator) NextFeature()
NextFeature advances to a new feature planning scope. All subsequent mutation registrations will be grouped into this scope until NextFeature is called again.
The first scope is created automatically by NewMutator. This method is called by the framework between mutations to maintain per-feature ordering semantics.
type Resource ¶
type Resource struct {
// contains filtered or unexported fields
}
Resource is a high-level abstraction for managing a Kubernetes NetworkPolicy within a controller's reconciliation loop.
It implements the following component interfaces:
- component.Resource: for basic identity and mutation behaviour.
- concepts.Guardable: for conditional reconciliation based on a guard precondition.
- concepts.DataExtractable: for exporting values after successful reconciliation.
NetworkPolicy resources are static: they do not model convergence health, grace periods, or suspension. Use a workload or task primitive for resources that require those concepts.
func (*Resource) ExtractData ¶
ExtractData executes all registered data extractor functions against a deep copy of the reconciled NetworkPolicy.
This is called by the framework after successful reconciliation, allowing the component to read generated or updated values from the NetworkPolicy.
func (*Resource) GuardStatus ¶ added in v0.4.0
func (r *Resource) GuardStatus() (concepts.GuardStatusWithReason, error)
GuardStatus evaluates the resource's guard precondition. If no guard was registered, the resource is unconditionally unblocked.
func (*Resource) Identity ¶
Identity returns a unique identifier for the NetworkPolicy in the format "networking.k8s.io/v1/NetworkPolicy/<namespace>/<name>".
func (*Resource) Mutate ¶
Mutate transforms the current state of a Kubernetes NetworkPolicy into the desired state.
The mutation process follows this order:
- The desired base state is applied to the current object.
- Feature mutations: all registered feature-gated mutations are applied in order.
This method is invoked by the framework during the Update phase of reconciliation.
func (*Resource) Object ¶
Object returns a deep copy of the underlying Kubernetes NetworkPolicy object.
The returned object implements client.Object, making it compatible with controller-runtime's Client for Create, Update, and Patch operations.
func (*Resource) PreviewObject ¶ added in v0.6.0
func (r *Resource) PreviewObject() (*networkingv1.NetworkPolicy, error)
PreviewObject returns the NetworkPolicy as it would appear after feature mutations have been applied, without modifying the resource's internal state.
Suspension mutations are not applied; the preview reflects content state only.
Source Files