Explain how Agent Secret Works (#5625)

* first version Signed-off-by: Future-Outlier <[email protected]> * update Signed-off-by: Future-Outlier <[email protected]> --------- Signed-off-by: Future-Outlier <[email protected]>
flyteorg · Aug 2, 2024 · b6bc902 · b6bc902
1 parent 7e16ff4
commit b6bc902
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/docs/flyte_agents/how_secret_works_in_agent.md b/docs/flyte_agents/how_secret_works_in_agent.md
@@ -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\"}}"
+```
diff --git a/docs/flyte_agents/index.md b/docs/flyte_agents/index.md
@@ -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}
@@ -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
 ```