README
¶
pkg/controller/proposalvalidator
Validates hypothetical configuration changes by rendering live stores with temporary overlays. Service owns validation; Component connects it to proposal events.
Validation policies
| Caller | Entry point | Failure policy |
|---|---|---|
| Admission webhook | Service.ValidateSyncWithAdmissionSubject |
Checks observed inputs, then retries with only exact rejected revisions withheld |
| Background HTTP refresh | Component handling ProposalValidationRequestedEvent |
Rejects invalid proposed output, including output identical to an invalid baseline |
The observed-input path retains its exact unchanged-output comparison. The
isolated-input fallback must produce valid output; it never uses that exception.
ObservedStoreProvider keeps admission snapshots in the reconciliation revision
family. AdmissionStoreProvider preserves all observed changes except exact
rejected revisions; AcceptedStoreProvider supplies validated inputs for HTTP
content proposals.
Cancellation and unavailable published files reject admission. Neither can use the unchanged-invalid exception. CurrentFilesProvider supplies one snapshot per decision, shared by the proposed and baseline renders.
Admission service
service := proposalvalidator.NewService(&proposalvalidator.ServiceConfig{
Pipeline: admissionPipeline,
BaseStoreProvider: storeProvider,
CurrentFilesProvider: currentFilesProvider,
Logger: logger,
})
pipelineResult, result := service.ValidateSync(ctx, overlays)
The service has no event subscription or lifecycle. ValidateSync returns (*pipeline.PipelineResult, *validation.ValidationResult). An admitted result includes the proposed rendered output, including when admission uses the unchanged-invalid exception. Rejections include the failing phase, error, and any warnings.
HTTP-content event adapter
adapter := proposalvalidator.New(eventBus, &proposalvalidator.ServiceConfig{
Pipeline: proposalPipeline,
BaseStoreProvider: storeProvider,
CurrentFilesProvider: currentFilesProvider,
Logger: logger,
})
eventBus.Start()
go adapter.Start(ctx)
Construct every subscriber before starting the event bus. The adapter publishes a verdict carrying the request ID, including when validation panics. Cancelling its lifecycle context cancels active validation.
Related packages
pipeline— render and validation executiondryrunvalidator— admission overlays and error reportinghttpstore— pending HTTP-content promotionstores— temporary resource and HTTP overlays
Documentation
¶
Overview ¶
Package proposalvalidator validates hypothetical configuration changes.
Index ¶
- Constants
- type Component
- type Service
- func (c *Service) ValidateSync(ctx context.Context, overlays map[string]*stores.StoreOverlay) (*pipeline.PipelineResult, *validation.ValidationResult)
- func (c *Service) ValidateSyncWithAdmissionSubject(ctx context.Context, overlays map[string]*stores.StoreOverlay, ...) (*pipeline.PipelineResult, *validation.ValidationResult)
- type ServiceConfig
Constants ¶
const ( ComponentName = "proposalvalidator" EventBufferSize = busevents.StandardSubscriberBuffer )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Component ¶
Component adapts proposal-validation requests to the validation service.
func New ¶
func New(eventBus *busevents.EventBus, cfg *ServiceConfig) *Component
New subscribes to proposal-validation requests during construction.
func (*Component) HandleEvent ¶
HandleEvent implements component.EventHandler: it processes incoming events.
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
Service validates proposed changes against the current stores.
func NewService ¶
func NewService(cfg *ServiceConfig) *Service
NewService creates a validator without an event subscription or lifecycle.
func (*Service) ValidateSync ¶
func (c *Service) ValidateSync(ctx context.Context, overlays map[string]*stores.StoreOverlay) (*pipeline.PipelineResult, *validation.ValidationResult)
ValidateSync admits unchanged invalid output only after an exact baseline comparison.
func (*Service) ValidateSyncWithAdmissionSubject ¶
func (c *Service) ValidateSyncWithAdmissionSubject(ctx context.Context, overlays map[string]*stores.StoreOverlay, storeAliases []string, namespace, name string) (*pipeline.PipelineResult, *validation.ValidationResult)
ValidateSyncWithAdmissionSubject validates one admitted object across every configured store alias affected by the request.
type ServiceConfig ¶
type ServiceConfig struct {
Pipeline *pipeline.Pipeline
BaseStoreProvider stores.StoreProvider
// FreshStoreProvider supplies API-backed inputs when a cached render rejects admission.
FreshStoreProvider func(context.Context) (stores.StoreProvider, error)
// AcceptedStoreProvider supplies inputs that passed complete output validation.
AcceptedStoreProvider func() (stores.StoreProvider, bool)
// AdmissionStoreProvider excludes only rejected revisions from observed inputs.
AdmissionStoreProvider func(context.Context, stores.StoreProvider) (stores.StoreProvider, bool, error)
// ObservedStoreProvider preserves the reconciliation input revision family.
ObservedStoreProvider func(context.Context, stores.StoreProvider) (stores.StoreProvider, error)
// CurrentFilesProvider pins one published baseline across both renders.
CurrentFilesProvider func() (map[string]string, error)
Logger *slog.Logger
}
ServiceConfig supplies the validation pipeline and its inputs.
Source Files