Route VCL P2: VarnishVCLPolicy CRD and the GatewayClassParameters gate

Open
#97 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 5 days

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
1-2 days
Newbie friendliness
52/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
go
Domain
api, backend

Research direction

Start by reading the existing VarnishCachePolicy model and policy CRDs, then find the GatewayClassParameters definitions and condition handling. The issue depends on a security decision in #94, so read that decision before making changes. Done means the new CRD is installable, conditions are set, and gateway behavior is unchanged.

Written by the indexing model from the issue text.

Description

enhancement

Part of #94. Depends on the security decision.

Add the API, set conditions, change no behaviour. Shipping this first lets the API be reviewed on its own.

Work

  • VarnishVCLPolicy CRD, modelled on VarnishCachePolicy: a targetRef of {group, kind, name, sectionName} accepting Gateway or HTTPRoute, plus a ConfigMap reference and key. Ancestor status, as the other policy CRDs have.
  • GatewayClassParameters additions: the gate from the security decision, and routeVCL.slotPoolSize.
  • Status conditions: Accepted; Invalid for a bad reference, a namespace that is not permitted, or no slot available; Programmed once the VCL has compiled and been labelled on every pod.

Done when

The CRD is installable, the operator sets conditions on it, and nothing else about the gateway changes.

Notes

Size M.

Dominant language
Go
Stars
16
Forks
3
Avg merge
5d 15h
Merged PRs (30d)
10

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from varnish/gateway

All issues in varnish/gateway

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.