APIs
Packages:
kynomesh.kyno.sh/v1alpha1
Resource Types:
AbstractAgentDeploy
(Appears on: AgentDeploySpec, AgentSetSpec)
| Field | Description |
|---|---|
name string
|
|
AbstractPodTemplate
AbstractPodTemplate
|
(Members of |
container
Container
|
Agent container, the user’s agent code runs here. |
brokerContainer
ContainerTemplate
|
(Optional)
Container template for the broker container. |
volumes
\[\]Kubernetes core/v1.Volume
|
(Optional) |
scale
Scale
|
(Optional)
Settings for autoscaling |
rateLimit
RateLimit
|
(Optional)
RateLimit configures broker-side admission control. When unset, the broker admits requests without limit. |
initContainers
\[\]Kubernetes core/v1.Container
|
(Optional)
List of customized init containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
sidecars
\[\]Kubernetes core/v1.Container
|
(Optional)
List of customized sidecar containers belonging to the pod. |
updateStrategy
UpdateStrategy
|
(Optional)
The strategy to use to replace existing pods with new ones. |
publicBaseURL string
|
(Optional)
PublicBaseURL is the externally reachable base URL of this agent’s broker (e.g. https://agent.example.com). When set, the broker uses it to rewrite AgentCard SupportedInterfaces URLs so external clients can reach the agent through an ingress or gateway in front of the cluster. If empty, the broker advertises its in-cluster address. |
AbstractPodTemplate
(Appears on: AbstractAgentDeploy, AgentDeployTemplate, DaemonTemplate)
AbstractPodTemplate provides a template for pod customization in vertices, daemon deployments and so on.
| Field | Description |
|---|---|
metadata
Metadata
|
(Optional)
Metadata sets the pods’s metadata, i.e. annotations and labels |
nodeSelector map\[string\]string
|
(Optional)
NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
tolerations
\[\]Kubernetes core/v1.Toleration
|
(Optional)
If specified, the pod’s tolerations. |
securityContext
Kubernetes core/v1.PodSecurityContext
|
(Optional)
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. |
imagePullSecrets
\[\]Kubernetes core/v1.LocalObjectReference
|
(Optional)
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod |
priorityClassName string
|
(Optional)
If specified, indicates the pod’s priority. “system-node-critical” and “system-cluster-critical” are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. More info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/ |
priority int32
|
(Optional)
The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. More info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/ |
affinity
Kubernetes core/v1.Affinity
|
(Optional)
The pod’s scheduling constraints More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ |
serviceAccountName string
|
(Optional)
ServiceAccountName applied to the pod |
runtimeClassName string
|
(Optional)
RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the “legacy” RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class |
automountServiceAccountToken bool
|
(Optional)
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. |
dnsPolicy
Kubernetes core/v1.DNSPolicy
|
(Optional)
Set DNS policy for the pod. Defaults to “ClusterFirst”. Valid values are ‘ClusterFirstWithHostNet’, ‘ClusterFirst’, ‘Default’ or ‘None’. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to ‘ClusterFirstWithHostNet’. |
dnsConfig
Kubernetes core/v1.PodDNSConfig
|
(Optional)
Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. |
resourceClaims
\[\]Kubernetes core/v1.PodResourceClaim
|
(Optional)
ResourceClaims defines which ResourceClaims must be allocated and reserved before the Pod is allowed to start. The resources will be made available to those containers which consume them by name. |
terminationGracePeriodSeconds int64
|
(Optional)
TerminationGracePeriodSeconds is the optional duration in seconds the pod needs to terminate gracefully. The broker’s preStop hook drains in-flight requests within this window, so raise it for agents with long-running calls. Defaults to 120 when unset. |
AgentDeploy
| Field | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
metadata
Kubernetes meta/v1.ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
spec
AgentDeploySpec
|
|
||||||||
status
AgentDeployStatus
|
(Optional) |
AgentDeployPhase (string alias)
(Appears on: AgentDeployStatus)
AgentDeploySpec
(Appears on: AgentDeploy)
| Field | Description |
|---|---|
AbstractAgentDeploy
AbstractAgentDeploy
|
(Members of |
agentSetName string
|
AgentSetName is the name of the AgentSet that owns this AgentDeploy. |
replicas int32
|
(Optional) |
topology
Topology
|
(Optional)
Topology is stamped by the AgentSet controller and tells this agent which peers it should discover. |
AgentDeployStatus
(Appears on: AgentDeploy)
| Field | Description |
|---|---|
Status
Status
|
(Members of |
phase
AgentDeployPhase
|
(Optional) |
replicas uint32
|
(Optional)
Total number of non-terminated pods targeted by this AgentDeploy (their labels match the selector). |
desiredReplicas uint32
|
(Optional)
The number of desired replicas. |
selector string
|
(Optional) |
reason string
|
(Optional) |
message string
|
(Optional) |
lastScaledAt
Kubernetes meta/v1.Time
|
(Optional)
Time of last scaling operation. |
observedGeneration int64
|
(Optional)
The generation observed by the AgentDeploy controller. |
readyReplicas uint32
|
(Optional)
The number of pods targeted by this AgentDeploy with a Ready Condition. |
updatedReplicas uint32
|
The number of Pods created by the controller from the AgentDeploy version indicated by updateHash. |
updatedReadyReplicas uint32
|
The number of ready Pods created by the controller from the AgentDeploy version indicated by updateHash. |
currentHash string
|
If not empty, indicates the current version of the AgentDeploy used to generate Pods. |
updateHash string
|
If not empty, indicates the updated version of the AgentDeploy used to generate Pods. |
AgentDeployTemplate
(Appears on: Templates)
| Field | Description |
|---|---|
AbstractPodTemplate
AbstractPodTemplate
|
(Members of |
brokerContainer
ContainerTemplate
|
(Optional)
Template for the AgentDeploy broker container |
AgentPattern (string alias)
(Appears on: AgentSetSpec, Topology)
AgentPattern is the message-routing shape of an AgentSet.
AgentSet
| Field | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
metadata
Kubernetes meta/v1.ObjectMeta
|
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
spec
AgentSetSpec
|
|
||||||||
status
AgentSetStatus
|
(Optional) |
AgentSetPhase (string alias)
(Appears on: AgentSetStatus)
AgentSetSpec
(Appears on: AgentSet)
| Field | Description |
|---|---|
pattern
AgentPattern
|
Pattern describes how the agents in this AgentSet are wired together.
|
entry string
|
Entry is the name of the agent external callers reach first. Must match one of agents\[\].name. For Sequential it must be agents\[0\]. |
agents
\[\]AbstractAgentDeploy
|
|
templates
Templates
|
(Optional)
Templates are used to customize additional kubernetes resources required for the Pipeline |
AgentSetStatus
(Appears on: AgentSet)
| Field | Description |
|---|---|
Status
Status
|
(Members of |
phase
AgentSetPhase
|
(Optional) |
message string
|
(Optional) |
lastUpdated
Kubernetes meta/v1.Time
|
(Optional) |
agentCount uint32
|
(Optional) |
observedGeneration int64
|
(Optional)
The generation observed by the controller. |
ConditionType (string alias)
ConditionType is a valid value of Condition.Type
Container
(Appears on: AbstractAgentDeploy)
Container is used to define the container properties for user agent.
| Field | Description |
|---|---|
image string
|
(Optional) |
command \[\]string
|
(Optional) |
args \[\]string
|
(Optional) |
env
\[\]Kubernetes core/v1.EnvVar
|
(Optional) |
envFrom
\[\]Kubernetes core/v1.EnvFromSource
|
(Optional) |
volumeMounts
\[\]Kubernetes core/v1.VolumeMount
|
(Optional) |
resources
Kubernetes core/v1.ResourceRequirements
|
(Optional) |
securityContext
Kubernetes core/v1.SecurityContext
|
(Optional) |
imagePullPolicy
Kubernetes core/v1.PullPolicy
|
(Optional) |
readinessProbe
Probe
|
(Optional) |
livenessProbe
Probe
|
(Optional) |
ports
\[\]Kubernetes core/v1.ContainerPort
|
(Optional) |
ContainerTemplate
(Appears on: AbstractAgentDeploy, AgentDeployTemplate, DaemonTemplate)
ContainerTemplate defines customized spec for a container
| Field | Description |
|---|---|
resources
Kubernetes core/v1.ResourceRequirements
|
(Optional) |
imagePullPolicy
Kubernetes core/v1.PullPolicy
|
(Optional) |
securityContext
Kubernetes core/v1.SecurityContext
|
(Optional) |
env
\[\]Kubernetes core/v1.EnvVar
|
(Optional) |
envFrom
\[\]Kubernetes core/v1.EnvFromSource
|
(Optional) |
DaemonTemplate
(Appears on: Templates)
DaemonTemplate customizes the per-AgentSet daemon Deployment’s pod.
| Field | Description |
|---|---|
AbstractPodTemplate
AbstractPodTemplate
|
(Members of |
container
ContainerTemplate
|
Container for the daemon container (resources, env, …). |
Metadata
(Appears on: AbstractPodTemplate)
| Field | Description |
|---|---|
annotations map\[string\]string
|
|
labels map\[string\]string
|
Peer
(Appears on: Topology)
Peer is a single discoverable agent reference.
| Field | Description |
|---|---|
name string
|
Name is the short agent name. |
kind
PeerKind
|
(Optional)
Kind tells the broker how to reach this peer. |
url string
|
(Optional)
URL is the full URL of the peer’s broker. For Managed peers it is populated by the init container from cluster DNS; for External peers it must be supplied by the user. |
PeerKind (string alias)
(Appears on: Peer)
PeerKind is how the broker should treat a peer entry.
Probe
(Appears on: Container)
Probe is used to customize the configuration for Readiness and Liveness probes.
| Field | Description |
|---|---|
initialDelaySeconds int32
|
(Optional)
Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
timeoutSeconds int32
|
(Optional)
Number of seconds after which the probe times out. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
periodSeconds int32
|
(Optional)
How often (in seconds) to perform the probe. |
successThreshold int32
|
(Optional)
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. |
failureThreshold int32
|
(Optional)
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
RateLimit
(Appears on: AbstractAgentDeploy)
RateLimit configures broker-side admission control for an agent.
| Field | Description |
|---|---|
maxInFlight int32
|
(Optional)
MaxInFlight caps the number of concurrent in-flight A2A requests the broker admits. Requests beyond the cap are rejected immediately (HTTP 429 with Retry-After, gRPC RESOURCE_EXHAUSTED) instead of being queued. Only A2A traffic (JSON-RPC, REST, gRPC) counts against the cap; passthrough (non-A2A) traffic is not gated. 0 or unset means unlimited. |
RollingUpdateStrategy
(Appears on: UpdateStrategy)
RollingUpdateStrategy is used to communicate parameter for RollingUpdateStrategyType.
| Field | Description |
|---|---|
maxUnavailable
k8s.io/apimachinery/pkg/util/intstr.IntOrString
|
(Optional)
The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. Defaults to 25%. Example: when this is set to 30%, the old pods can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old pods can be scaled down further, followed by scaling up the new pods, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. |
Scale
(Appears on: AbstractAgentDeploy)
Scale defines the parameters for autoscaling.
| Field | Description |
|---|---|
disabled bool
|
(Optional)
Whether to disable autoscaling. Set to “true” when using Kubernetes HPA or any other 3rd party autoscaling strategies. |
min int32
|
(Optional)
Minimum replicas. |
max int32
|
(Optional)
Maximum replicas. |
targetSaturationPercentage uint32
|
(Optional)
TargetSaturationPercentage tunes how aggressively to scale. It is the fraction (1-100) of a replica’s learned capacity (the saturation knee) to run at in steady state. The autoscaler learns each replica’s capacity from observed load and keeps the fleet near this fraction of it: desired replicas trend toward ceil(totalInflight / (knee \* TargetSaturationPercentage/100)). Lower values scale out earlier (safer latency, higher cost); higher values pack tighter (lower cost, higher latency risk). Values above 100 are rejected. Defaults to 80 when unset. |
scaleUpCooldownSeconds uint32
|
(Optional)
ScaleUpCooldownSeconds defines the cooldown seconds after a scaling operation, before a follow-up scaling up. |
scaleDownCooldownSeconds uint32
|
(Optional)
ScaleDownCooldownSeconds defines the cooldown seconds after a scaling operation, before a follow-up scaling down. |
replicasPerScaleUp uint32
|
(Optional)
ReplicasPerScaleUp defines the number of maximum replicas that can be changed in a single scaled up operation. The is use to prevent from too aggressive scaling up operations |
replicasPerScaleDown uint32
|
(Optional)
ReplicasPerScaleDown defines the number of maximum replicas that can be changed in a single scaled down operation. The is use to prevent from too aggressive scaling down operations |
Status
(Appears on: AgentDeployStatus, AgentSetStatus)
Status is a common structure which can be used for Status field.
| Field | Description |
|---|---|
conditions
\[\]Kubernetes meta/v1.Condition
|
(Optional)
Conditions are the latest available observations of a resource’s current state. |
Templates
(Appears on: AgentSetSpec)
| Field | Description |
|---|---|
agent
AgentDeployTemplate
|
|
daemon
DaemonTemplate
|
Topology
(Appears on: AgentDeploySpec)
Topology captures the information an agent needs to know about: the routing pattern, whether it is the entry agent, and the set of peers it is allowed to discover.
| Field | Description |
|---|---|
pattern
AgentPattern
|
(Optional)
Pattern is the AgentSet’s routing pattern. |
isEntry bool
|
(Optional)
IsEntry is true if this agent is the AgentSet’s entry agent. |
peers
\[\]Peer
|
(Optional)
Peers lists the agents this agent is allowed to discover, derived from Pattern. Names are short agent names. |
UpdateStrategy
(Appears on: AbstractAgentDeploy)
UpdateStrategy indicates the strategy that the controller will use to perform updates for AgentDeploy.
| Field | Description |
|---|---|
type
UpdateStrategyType
|
(Optional)
Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate. |
rollingUpdate
RollingUpdateStrategy
|
(Optional)
RollingUpdate is used to communicate parameters when Type is RollingUpdateStrategy. |
UpdateStrategyType (string alias)
(Appears on: UpdateStrategy)
UpdateStrategyType is a string enumeration type that enumerates all possible update strategies.
Generated with gen-crd-api-reference-docs.