API Reference
Packages
orama.trirematics.io/v1
Package v1 contains API Schema definitions for the orama v1 API group
Resource Types
AIFabric
AIFabric is the Schema for the AIFabric API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | orama.trirematics.io/v1 | ||
kind string | AIFabric | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | Optional: {} | |
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | Optional: {} | |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | Optional: {} Optional: {} | |
spec AIFabricSpec | Spec is the desired state of the AIFabric | ||
status AIFabricStatus | Status is the observed state of the AIFabric |
AIFabricList
AIFabricList contains a list of AIFabric
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | orama.trirematics.io/v1 | ||
kind string | AIFabricList | ||
kind string | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | Optional: {} | |
apiVersion string | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | Optional: {} | |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | Optional: {} Optional: {} | |
items AIFabric array | Items is the list of AIFabric objects. |
AIFabricSpec
AIFabricSpec defines the desired state of AIFabric
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
ui string | UI is the URL of the Docker Image hosting the UI for the AIFabric. | Optional: {} | |
imagePullSecrets LocalObjectReference array | ImagePullSecrets is a list of references to secrets for pulling images for the AIFabric components. | Optional: {} | |
mcp MCPServer array | MCP is a list of MCP Servers exposing tools for the Agents. | Optional: {} | |
llms LLM array | LLMs is a list of LLM services used by the Agents. | MinItems: 1 Required: {} | |
topology string | Topology defines the topology of the agentic workflow in the AIFabric. It | Enum: [supervised custom] Required: {} | |
agents Agent array | Agents is a list of Agents in the AIFabric. | MinItems: 1 Required: {} |
AIFabricStatus
AIFabricStatus defines the observed state of AIFabric
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
mcp string array | MCP is a list of MCP Server Deployments deployed for the AIFabric. | Optional: {} | |
llms string array | LLMs is a list of LLM ConfigMaps deployed for the AIFabric. | Optional: {} | |
agents string array | Agents is a list of Agent Deployments deployed for the AIFabric. | Optional: {} | |
roles string array | Roles is a list of Roles created for the AIFabric. These can be 'readonly' and/or 'readwrite' roles for the SMO and RIC operators. Currently supported: 'smo-readonly', 'smo-readwrite', 'ric-readonly', 'ric-readwrite'. | Optional: {} | |
ui string | UI indicates whether the UI Deployment has been created for the AIFabric. | Optional: {} |
Agent
Agent defines an Agent in the AIFabric.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
role string | Role is the role of the agent. | Enum: [supervisor worker] Optional: {} | |
llm string | LLM is the name of the LLM the agent must use. | Required: {} | |
icp ICP | ICP defines the Interagent Communication Protocol, used for communication between agents. It can be "a2a" or "mcp". | Enum: [a2a mcp] | |
mcpServers string array | MCPServers is a list of MCP Servers the agent can use. | Optional: {} | |
dependencies string array | Dependencies is a list of Agents that this Agent can call to perform sub-tasks. | Optional: {} |
ICP
Underlying type: string
ICP defines the Interagent Communication Protocol options.
Validation:
- Enum: [a2a mcp]
Appears in:
| Field | Description |
|---|---|
a2a | |
mcp |
LLM
LLM defines how to reach a large language model (LLM) service.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name is the name of the LLM service. | MaxLength: 63 MinLength: 1 Required: {} | |
provider ModelProviderName | ModelProvider is the provider of the language model. | Enum: [anthropic deepseek nvidia ollama openai] Required: {} | |
model string | ModelName is the name of the language model to use. | Required: {} | |
apiKeySecretRef SecretKeySelector | ApiKeySecretRef is a reference to a Secret containing the API key. | Optional: {} | |
baseUrl string | BaseUrl is the base URL where the language model API is hosted. | Optional: {} |
MCPServer
MCPServer defines an MCP Server exposing tools for the Agents in the AIFabric.
Appears in:
ModelProviderName
Underlying type: string
Validation:
- Enum: [anthropic deepseek nvidia ollama openai]
Appears in:
| Field | Description |
|---|---|
anthropic | |
deepseek | |
nvidia | |
ollama | |
openai |