You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -123,7 +123,7 @@ It's difficult to cover all the possible scenarios that you might encounter when
123
123
124
124
DCO, short for Developer Certificate of Origin, is a per-commit signoff that you, the contributor, agree to the terms published at [https://developercertificate.org](https://developercertificate.org) for that particular commit. This will appear as a `Signed-off-by: Your Name <your.email>` trailer at the end of each commit message. The kagent project requires that every commit contains this DCO signoff.
125
125
126
-
The easiest way to make sure each of your commits contains the signoff is to run make `init-git-hooks` in the repo to which you are contributing. This will configure your repo to use a Git hook which will automatically add the required trailer to all of your commit messages.
126
+
The easiest way to make sure each of your commits contains the signoff is to run `make init-git-hooks` in the repo to which you are contributing. This will configure your repo to use a Git hook which will automatically add the required trailer to all of your commit messages.
127
127
128
128
```shell
129
129
make init-git-hooks
@@ -229,7 +229,7 @@ All code must be reviewed by at least one [maintainer](https://github.com/kagent
229
229
230
230
## Documentation
231
231
232
-
The kagent documentation lives at [kagent.dev/docs](https://kagent.dev/docs/kagent). The code lives at [kagent website](https://github.com/kagent-dev/website).
232
+
The kagent documentation lives at [kagent.dev/docs/kagent](https://kagent.dev/docs/kagent). The code lives at [kagent website](https://github.com/kagent-dev/website).
Copy file name to clipboardExpand all lines: DEVELOPMENT.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
# Development
2
2
3
-
To understand how to develop for kagent, It's important to understand the architecture of the project. Please refer to the [README.md](README.md#architecture) file for an overview of the project.
3
+
To understand how to develop for kagent, it's important to understand the architecture of the project. Please refer to the [README.md](README.md#architecture) file for an overview of the project.
4
4
5
5
When making changes to `kagent`, the most important thing is to figure out which piece of the project is affected by the change, and then make the change in the appropriate folder. Each piece of the project has its own README with more information about how to setup the development environment and run that piece of the project.
6
6
7
-
-[python](python): Contains the code for the ADK engine.
7
+
-[python](python): Contains the code for the ADK engine.
8
8
-[go](go): Contains the code for the kubernetes controller, and the CLI.
Copy file name to clipboardExpand all lines: README.md
+3-5Lines changed: 3 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,7 +55,7 @@
55
55
</td>
56
56
</tr>
57
57
</table>
58
-
<!-- markdownlint-disable MD033 -->
58
+
<!-- markdownlint-enable MD033 -->
59
59
60
60
---
61
61
@@ -69,13 +69,13 @@
69
69
### Core Concepts
70
70
71
71
-**Agents**: Agents are the main building block of kagent. They are a system prompt, a set of tools and agents, and an LLM configuration represented with a Kubernetes custom resource called "Agent".
72
-
-**LLM Providers**: Kagent supports multiple LLM providers, including [OpenAI](https://kagent.dev/docs/kagent/supported-providers/openai), [Azure OpenAI](https://kagent.dev/docs/kagent/supported-providers/azure-openai), [Anthropic](https://kagent.dev/docs/kagent/supported-providers/anthropic), [Google Vertex AI](https://kagent.dev/docs/kagent/supported-providers/google-vertexai), [Ollama](https://kagent.dev/docs/kagent/supported-providers/ollama) and any other [custom providers and models](https://kagent.dev/docs/kagent/supported-providers/custom-models) accessible via AI gateways. Providers are represented by the ModelConfig resource.
72
+
-**LLM Providers**: Kagent supports multiple LLM providers, including [OpenAI](https://kagent.dev/docs/kagent/supported-providers/openai), [Azure OpenAI](https://kagent.dev/docs/kagent/supported-providers/azure-openai), [Anthropic](https://kagent.dev/docs/kagent/supported-providers/anthropic), [Google Vertex AI](https://kagent.dev/docs/kagent/supported-providers/google-vertexai), [Ollama](https://kagent.dev/docs/kagent/supported-providers/ollama) and any other custom providers and models accessible via AI gateways. Providers are represented by the ModelConfig resource.
73
73
-**MCP Tools**: Agents can connect to any MCP server that provides tools. Kagent comes with an MCP server with tools for Kubernetes, Istio, Helm, Argo, Prometheus, Grafana, Cilium, and others. All tools are Kubernetes custom resources (ToolServers) and can be used by multiple agents.
74
74
-**Observability**: Kagent supports [OpenTelemetry tracing](https://kagent.dev/docs/kagent/getting-started/tracing), which allows you to monitor what's happening with your agents and tools.
75
75
76
76
### Core Principles
77
77
78
-
-**Kubernetes Native**: Kagent is designed to be easy to understand and use, and to provide a flexible and powerful way to build and manage AI agents.
78
+
-**Kubernetes Native**: Agents and tools are managed as Kubernetes custom resources using familiar `kubectl` workflows.
79
79
-**Extensible**: Kagent is designed to be extensible, so you can add your own agents and tools.
80
80
-**Flexible**: Kagent is designed to be flexible, to suit any AI agent use case.
81
81
-**Observable**: Kagent is designed to be observable, so you can monitor the agents and tools using all common monitoring frameworks.
@@ -84,8 +84,6 @@
84
84
85
85
### Architecture
86
86
87
-
The kagent framework is designed to be easy to understand and use, and to provide a flexible and powerful way to build and manage AI agents.
Copy file name to clipboardExpand all lines: SECURITY.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,31 +10,31 @@ To report a security vulnerability, email the private Google group kagent-vulner
10
10
11
11
Send a report when:
12
12
13
-
You discover that a kagent component has a potential security vulnerability.
14
-
You are unsure whether or how a vulnerability affects kagent.
13
+
- You discover that a kagent component has a potential security vulnerability.
14
+
- You are unsure whether or how a vulnerability affects kagent.
15
15
16
16
### 🔔 Check before sending
17
17
18
18
If in doubt, send a private message about potential vulnerabilities such as:
19
19
20
-
Any crash, especially in kagent.
21
-
Any potential Denial of Service (DoS) attack.
20
+
- Any crash, especially in kagent.
21
+
- Any potential Denial of Service (DoS) attack.
22
22
23
23
### ❌ When NOT to send a report
24
24
25
25
Do not send a report for vulnerabilities that are not part of the kagent project, such as:
26
26
27
-
You want help configuring kagent components for security purposes.
28
-
You want help applying security related updates to your kagent configuration or environment.
29
-
Your issue is not related to security vulnerabilities.
30
-
Your issue is related to base image dependencies, such as AutoGen.
27
+
- You want help configuring kagent components for security purposes.
28
+
- You want help applying security related updates to your kagent configuration or environment.
29
+
- Your issue is not related to security vulnerabilities.
30
+
- Your issue is related to base image dependencies, such as AutoGen.
31
31
32
32
### Evaluation
33
33
34
34
The kagent team evaluates vulnerability reports for:
35
35
36
-
Severity level, which can affect the priority of the fix
37
-
Impact of the vulnerability on kagent code as opposed to backend code
38
-
Potential dependencies on third-party or backend code that might delay the remediation process
36
+
- Severity level, which can affect the priority of the fix
37
+
- Impact of the vulnerability on kagent code as opposed to backend code
38
+
- Potential dependencies on third-party or backend code that might delay the remediation process
39
39
40
40
The kagent team strives to keep private any vulnerability information with us as part of the remediation process. We only share information on a need-to-know basis to address the issue.
0 commit comments