Skip to content

Commit 750b5e2

Browse files
committed
docs: provide text for 'oc explain' on operator CRDs
Signed-off-by: Ed Snible <snible@us.ibm.com>
1 parent b52923c commit 750b5e2

5 files changed

Lines changed: 14 additions & 27 deletions

File tree

kagenti-operator/api/v1alpha1/agentcard_types.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,9 @@ type SkillParameter struct {
345345
// +kubebuilder:printcolumn:name="LastSync",type="date",JSONPath=".status.lastSyncTime",description="Last Sync Time"
346346
// +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
347347

348-
// AgentCard is the Schema for the agentcards API.
348+
// AgentCard binds an A2A agent card to a backing workload. The controller periodically
349+
// fetches the card from the referenced workload, verifies its JWS signature and SPIFFE
350+
// identity against the configured trust domain, and caches the result in status.
349351
type AgentCard struct {
350352
metav1.TypeMeta `json:",inline"`
351353
metav1.ObjectMeta `json:"metadata,omitempty"`

kagenti-operator/api/v1alpha1/agentruntime_types.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,9 @@ type AgentRuntimeStatus struct {
124124
// +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase",description="Runtime Phase"
125125
// +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
126126

127-
// AgentRuntime is the Schema for the agentruntimes API.
127+
// AgentRuntime attaches runtime configuration to a backing workload classified as an
128+
// agent or tool, providing per-workload overrides for SPIFFE identity and OpenTelemetry
129+
// tracing. The controller reports pod configuration coverage and phase in status.
128130
type AgentRuntime struct {
129131
metav1.TypeMeta `json:",inline"`
130132
metav1.ObjectMeta `json:"metadata,omitempty"`

kagenti-operator/config/crd/bases/agent.kagenti.dev_agentcards.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,10 @@ spec:
5656
name: v1alpha1
5757
schema:
5858
openAPIV3Schema:
59-
description: AgentCard is the Schema for the agentcards API.
59+
description: |-
60+
AgentCard binds an A2A agent card to a backing workload. The controller periodically
61+
fetches the card from the referenced workload, verifies its JWS signature and SPIFFE
62+
identity against the configured trust domain, and caches the result in status.
6063
properties:
6164
apiVersion:
6265
description: |-

kagenti-operator/config/crd/bases/agent.kagenti.dev_agentruntimes.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,10 @@ spec:
3636
name: v1alpha1
3737
schema:
3838
openAPIV3Schema:
39-
description: AgentRuntime is the Schema for the agentruntimes API.
39+
description: |-
40+
AgentRuntime attaches runtime configuration to a backing workload classified as an
41+
agent or tool, providing per-workload overrides for SPIFFE identity and OpenTelemetry
42+
tracing. The controller reports pod configuration coverage and phase in status.
4043
properties:
4144
apiVersion:
4245
description: |-

kagenti-operator/config/webhook/manifests.yaml

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -13,28 +13,6 @@ webhooks:
1313
path: /mutate-workloads-authbridge
1414
failurePolicy: Fail
1515
name: inject.kagenti.io
16-
namespaceSelector:
17-
matchExpressions:
18-
- key: kubernetes.io/metadata.name
19-
operator: NotIn
20-
values:
21-
- kube-system
22-
- kube-public
23-
- kube-node-lease
24-
- kagenti-operator-system
25-
matchLabels:
26-
kagenti-enabled: "true"
27-
objectSelector:
28-
matchExpressions:
29-
- key: kagenti.io/type
30-
operator: In
31-
values:
32-
- agent
33-
- tool
34-
- key: kagenti.io/inject
35-
operator: NotIn
36-
values:
37-
- disabled
3816
reinvocationPolicy: IfNeeded
3917
rules:
4018
- apiGroups:
@@ -46,7 +24,6 @@ webhooks:
4624
resources:
4725
- pods
4826
sideEffects: None
49-
timeoutSeconds: 10
5027
---
5128
apiVersion: admissionregistration.k8s.io/v1
5229
kind: ValidatingWebhookConfiguration

0 commit comments

Comments
 (0)