Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Explain how Agent Secret Works #5625

Merged
merged 2 commits into from
Aug 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/flyte_agents/how_secret_works_in_agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
jupytext:
formats: md:myst
text_representation:
extension: .md
format_name: myst
---

(how_secret_works_in_agent)=
# How Secret Works in Agent

In Flyte agent's deployment, we mount secrets in Kubernetes with the namespace `flyte` and the name `flyteagent`.
If you want to add secrets for agents, you can use the following command:

```bash
SECRET_VALUE=$(<YOUR_SECRET_VALUE> | base64) && kubectl patch secret flyteagent -n flyte --patch "{\"data\":{\"your_agent_secret_name\":\"$SECRET_VALUE\"}}"
```
3 changes: 3 additions & 0 deletions docs/flyte_agents/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ You can create different agent services that host different agents, e.g., a prod
- Once you have tested your new agent in a local development cluster and want to use it in production, you should test it in the Flyte sandbox.
* - {doc}`Implementing the agent metadata service <implementing_the_agent_metadata_service>`
- If you want to develop an agent server in a language other than Python (e.g., Rust or Java), you must implement the agent metadata service in your agent server.
* - {doc}`How secret works in agent <how_secret_works_in_agent>`
- Explain how secret works in your agent server.
```

```{toctree}
Expand All @@ -48,4 +50,5 @@ developing_agents
testing_agents_in_a_local_development_cluster
deploying_agents_to_the_flyte_sandbox
implementing_the_agent_metadata_service
how_secret_works_in_agent
```
Loading