Skip to content

Commit 8fc4099

Browse files
ChrisJBurnsclaude
andcommitted
Mark AuthzConfigRef staging NOTE with TODO(#4778)
The staging note on AuthzConfigRef becomes inaccurate the moment the workload-controller wiring lands. A grep-able TODO(#4778) marker in the Go source ensures whoever lands #4778 finds the stale text without manually scanning three type files. controller-gen strips TODO lines from the rendered CRD description, so the user-facing schema stays clean. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent db21821 commit 8fc4099

10 files changed

Lines changed: 36 additions & 3 deletions

cmd/thv-operator/api/v1beta1/mcpremoteproxy_types.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,9 @@ type MCPRemoteProxySpec struct {
9696
// The referenced MCPAuthzConfig must exist in the same namespace as this MCPRemoteProxy.
9797
// Mutually exclusive with authzConfig.
9898
//
99+
// TODO(#4778): remove the staging NOTE below once workload controllers
100+
// resolve AuthzConfigRef into a runtime authz config.
101+
//
99102
// NOTE: this field is consumed by workload controllers in a follow-up PR.
100103
// Until that lands, AuthzConfigRef is reference-tracked by the
101104
// MCPAuthzConfig controller (deletion protection, status.referenceCount)

cmd/thv-operator/api/v1beta1/mcpserver_types.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,9 @@ type MCPServerSpec struct {
308308
// The referenced MCPAuthzConfig must exist in the same namespace as this MCPServer.
309309
// Mutually exclusive with authzConfig.
310310
//
311+
// TODO(#4778): remove the staging NOTE below once workload controllers
312+
// resolve AuthzConfigRef into a runtime authz config.
313+
//
311314
// NOTE: this field is consumed by workload controllers in a follow-up PR.
312315
// Until that lands, AuthzConfigRef is reference-tracked by the
313316
// MCPAuthzConfig controller (deletion protection, status.referenceCount)

cmd/thv-operator/api/v1beta1/virtualmcpserver_types.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,9 @@ type IncomingAuthConfig struct {
187187
// The referenced MCPAuthzConfig must exist in the same namespace as this VirtualMCPServer.
188188
// Mutually exclusive with authzConfig.
189189
//
190+
// TODO(#4778): remove the staging NOTE below once workload controllers
191+
// resolve AuthzConfigRef into a runtime authz config.
192+
//
190193
// NOTE: this field is consumed by workload controllers in a follow-up PR.
191194
// Until that lands, AuthzConfigRef is reference-tracked by the
192195
// MCPAuthzConfig controller (deletion protection, status.referenceCount)

deploy/charts/operator-crds/files/crds/toolhive.stacklok.dev_mcpremoteproxies.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,8 @@ spec:
213213
The referenced MCPAuthzConfig must exist in the same namespace as this MCPRemoteProxy.
214214
Mutually exclusive with authzConfig.
215215
216+
resolve AuthzConfigRef into a runtime authz config.
217+
216218
NOTE: this field is consumed by workload controllers in a follow-up PR.
217219
Until that lands, AuthzConfigRef is reference-tracked by the
218220
MCPAuthzConfig controller (deletion protection, status.referenceCount)
@@ -863,6 +865,8 @@ spec:
863865
The referenced MCPAuthzConfig must exist in the same namespace as this MCPRemoteProxy.
864866
Mutually exclusive with authzConfig.
865867
868+
resolve AuthzConfigRef into a runtime authz config.
869+
866870
NOTE: this field is consumed by workload controllers in a follow-up PR.
867871
Until that lands, AuthzConfigRef is reference-tracked by the
868872
MCPAuthzConfig controller (deletion protection, status.referenceCount)

deploy/charts/operator-crds/files/crds/toolhive.stacklok.dev_mcpservers.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,8 @@ spec:
220220
The referenced MCPAuthzConfig must exist in the same namespace as this MCPServer.
221221
Mutually exclusive with authzConfig.
222222
223+
resolve AuthzConfigRef into a runtime authz config.
224+
223225
NOTE: this field is consumed by workload controllers in a follow-up PR.
224226
Until that lands, AuthzConfigRef is reference-tracked by the
225227
MCPAuthzConfig controller (deletion protection, status.referenceCount)
@@ -1166,6 +1168,8 @@ spec:
11661168
The referenced MCPAuthzConfig must exist in the same namespace as this MCPServer.
11671169
Mutually exclusive with authzConfig.
11681170
1171+
resolve AuthzConfigRef into a runtime authz config.
1172+
11691173
NOTE: this field is consumed by workload controllers in a follow-up PR.
11701174
Until that lands, AuthzConfigRef is reference-tracked by the
11711175
MCPAuthzConfig controller (deletion protection, status.referenceCount)

deploy/charts/operator-crds/files/crds/toolhive.stacklok.dev_virtualmcpservers.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2565,6 +2565,8 @@ spec:
25652565
The referenced MCPAuthzConfig must exist in the same namespace as this VirtualMCPServer.
25662566
Mutually exclusive with authzConfig.
25672567
2568+
resolve AuthzConfigRef into a runtime authz config.
2569+
25682570
NOTE: this field is consumed by workload controllers in a follow-up PR.
25692571
Until that lands, AuthzConfigRef is reference-tracked by the
25702572
MCPAuthzConfig controller (deletion protection, status.referenceCount)
@@ -5543,6 +5545,8 @@ spec:
55435545
The referenced MCPAuthzConfig must exist in the same namespace as this VirtualMCPServer.
55445546
Mutually exclusive with authzConfig.
55455547
5548+
resolve AuthzConfigRef into a runtime authz config.
5549+
55465550
NOTE: this field is consumed by workload controllers in a follow-up PR.
55475551
Until that lands, AuthzConfigRef is reference-tracked by the
55485552
MCPAuthzConfig controller (deletion protection, status.referenceCount)

deploy/charts/operator-crds/templates/toolhive.stacklok.dev_mcpremoteproxies.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,8 @@ spec:
216216
The referenced MCPAuthzConfig must exist in the same namespace as this MCPRemoteProxy.
217217
Mutually exclusive with authzConfig.
218218
219+
resolve AuthzConfigRef into a runtime authz config.
220+
219221
NOTE: this field is consumed by workload controllers in a follow-up PR.
220222
Until that lands, AuthzConfigRef is reference-tracked by the
221223
MCPAuthzConfig controller (deletion protection, status.referenceCount)
@@ -866,6 +868,8 @@ spec:
866868
The referenced MCPAuthzConfig must exist in the same namespace as this MCPRemoteProxy.
867869
Mutually exclusive with authzConfig.
868870
871+
resolve AuthzConfigRef into a runtime authz config.
872+
869873
NOTE: this field is consumed by workload controllers in a follow-up PR.
870874
Until that lands, AuthzConfigRef is reference-tracked by the
871875
MCPAuthzConfig controller (deletion protection, status.referenceCount)

deploy/charts/operator-crds/templates/toolhive.stacklok.dev_mcpservers.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,8 @@ spec:
223223
The referenced MCPAuthzConfig must exist in the same namespace as this MCPServer.
224224
Mutually exclusive with authzConfig.
225225
226+
resolve AuthzConfigRef into a runtime authz config.
227+
226228
NOTE: this field is consumed by workload controllers in a follow-up PR.
227229
Until that lands, AuthzConfigRef is reference-tracked by the
228230
MCPAuthzConfig controller (deletion protection, status.referenceCount)
@@ -1169,6 +1171,8 @@ spec:
11691171
The referenced MCPAuthzConfig must exist in the same namespace as this MCPServer.
11701172
Mutually exclusive with authzConfig.
11711173
1174+
resolve AuthzConfigRef into a runtime authz config.
1175+
11721176
NOTE: this field is consumed by workload controllers in a follow-up PR.
11731177
Until that lands, AuthzConfigRef is reference-tracked by the
11741178
MCPAuthzConfig controller (deletion protection, status.referenceCount)

deploy/charts/operator-crds/templates/toolhive.stacklok.dev_virtualmcpservers.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2568,6 +2568,8 @@ spec:
25682568
The referenced MCPAuthzConfig must exist in the same namespace as this VirtualMCPServer.
25692569
Mutually exclusive with authzConfig.
25702570
2571+
resolve AuthzConfigRef into a runtime authz config.
2572+
25712573
NOTE: this field is consumed by workload controllers in a follow-up PR.
25722574
Until that lands, AuthzConfigRef is reference-tracked by the
25732575
MCPAuthzConfig controller (deletion protection, status.referenceCount)
@@ -5546,6 +5548,8 @@ spec:
55465548
The referenced MCPAuthzConfig must exist in the same namespace as this VirtualMCPServer.
55475549
Mutually exclusive with authzConfig.
55485550
5551+
resolve AuthzConfigRef into a runtime authz config.
5552+
55495553
NOTE: this field is consumed by workload controllers in a follow-up PR.
55505554
Until that lands, AuthzConfigRef is reference-tracked by the
55515555
MCPAuthzConfig controller (deletion protection, status.referenceCount)

docs/operator/crd-api.md

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)