feat(cli): add env support in agent_metadata.yaml by madmecodes · Pull Request #315 · volcano-sh/agentcube

madmecodes · 2026-05-10T18:00:07Z

Summary

Adds first-class env support to agent_metadata.yaml so users can declare extra environment variables that get injected into sandbox pod containers during publish.

Right now the only way to get custom env vars (like LLM_BASE_URL, LLM_API_KEY) into a deployed agent is to manually patch the CRD after kubectl agentcube publish, and that gets overwritten on the next publish. This change lets you put them straight in the metadata file:

agent_name: my-agent
entrypoint: python main.py
port: 8080
env:
  LLM_BASE_URL: https://api.example.com
  LLM_API_KEY: sk-xxx

What changed

metadata_service.py -- added env: Optional[Dict[str, str]] field to AgentMetadata model. Defaults to None, excluded from saved YAML when absent.
publish_runtime.py -- both _publish_cr_to_k8s (AgentRuntime CR) and _publish_k8s (standard Deployment) now read metadata.env and merge it into the env_vars dict before passing to providers. Programmatic env_vars from options still override metadata values.
tests/test_env_support.py -- 10 unit tests covering model validation, YAML round-trip, and env forwarding to both providers.

Fixes #222

Test plan

AgentMetadata accepts env dict, defaults to None
YAML load/save round-trips env correctly
Saving metadata without env omits the field from YAML
env from metadata forwarded to AgentCube provider
env from metadata forwarded to K8s provider
No env passes None to providers (no regression)
All 10 tests pass locally

volcano-sh-bot · 2026-05-10T18:00:20Z

Welcome @madmecodes! It looks like this is your first PR to volcano-sh/agentcube 🎉

gemini-code-assist

Code Review

This pull request adds support for user-defined environment variables in agent_metadata.yaml by introducing an env field to the AgentMetadata model. The PublishRuntime logic was updated to merge these variables with CLI options during deployment, and a comprehensive test suite was added to ensure correct parsing and forwarding. Feedback suggests using dictionary unpacking to simplify the environment variable merging logic and reduce code duplication.

gemini-code-assist · 2026-05-10T18:01:41Z

+        env_vars = dict(metadata.env) if metadata.env else {}
+        if options.get('env_vars'):
+            env_vars.update(options['env_vars'])


The logic for merging environment variables can be simplified using dictionary unpacking. This approach is more concise and handles potential None values gracefully while ensuring that CLI options correctly override metadata values.

Suggested change

env_vars = dict(metadata.env) if metadata.env else {}

if options.get('env_vars'):

env_vars.update(options['env_vars'])

env_vars = {**(metadata.env or {}), **(options.get('env_vars') or {})}

gemini-code-assist · 2026-05-10T18:01:42Z

+        env_vars = dict(metadata.env) if metadata.env else {}
+        if options.get('env_vars'):
+            env_vars.update(options['env_vars'])


This merge logic is duplicated from _publish_cr_to_k8s. Using a concise dictionary unpacking approach improves readability and maintainability by reducing the boilerplate needed for merging optional dictionaries.

Suggested change

env_vars = dict(metadata.env) if metadata.env else {}

if options.get('env_vars'):

env_vars.update(options['env_vars'])

env_vars = {**(metadata.env or {}), **(options.get('env_vars') or {})}

Copilot

Pull request overview

This PR adds first-class support for user-defined environment variables in agent_metadata.yaml and wires them through the CLI publish flow so they are injected into sandbox pod containers for both the AgentRuntime CRD (“agentcube” provider) and standard Deployment (“k8s” provider).

Changes:

Extend the AgentMetadata model to include an optional env: Dict[str, str] field that is omitted from saved YAML when None.
Merge metadata.env with any programmatic env_vars options during publish (options take precedence) and forward the merged env to both deployment providers.
Add unit tests covering metadata YAML round-trip and env forwarding behavior.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 6 comments.

File	Description
cmd/cli/agentcube/services/metadata_service.py	Adds `env` field to `AgentMetadata` and relies on existing `exclude_none=True` YAML saving behavior.
cmd/cli/agentcube/runtime/publish_runtime.py	Merges `metadata.env` into `env_vars` and forwards to both AgentCube and Kubernetes providers.
cmd/cli/tests/test_env_support.py	New tests for env parsing/persistence and publish-time env forwarding.
cmd/cli/tests/init.py	No functional changes (file present for test package).

+from unittest.mock import MagicMock, patch
+
+import yaml
+import pytest


+
+        with tempfile.TemporaryDirectory() as tmpdir:
+            result = runtime.publish(Path(tmpdir), provider="agentcube")
+


+        with tempfile.TemporaryDirectory() as tmpdir:
+            result = runtime.publish(Path(tmpdir), provider="k8s")
+


+        with tempfile.TemporaryDirectory() as tmpdir:
+            result = runtime.publish(Path(tmpdir), provider="agentcube")
+


+        # Merge user-defined env from metadata with any env_vars from options
+        env_vars = dict(metadata.env) if metadata.env else {}
+        if options.get('env_vars'):
+            env_vars.update(options['env_vars'])


+        # Merge user-defined env from metadata with any env_vars from options
+        env_vars = dict(metadata.env) if metadata.env else {}
+        if options.get('env_vars'):
+            env_vars.update(options['env_vars'])


codecov-commenter · 2026-05-10T18:05:23Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 47.75%. Comparing base (524e55e) to head (d8f9bc2).
⚠️ Report is 29 commits behind head on main.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #315      +/-   ##
==========================================
+ Coverage   47.57%   47.75%   +0.18%     
==========================================
  Files          30       30              
  Lines        2819     2854      +35     
==========================================
+ Hits         1341     1363      +22     
- Misses       1338     1343       +5     
- Partials      140      148       +8

Flag	Coverage Δ
unittests	`47.75% <ø> (+0.18%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

Pull request overview

Copilot reviewed 3 out of 4 changed files in this pull request and generated 4 comments.

+        if options.get('env_vars'):
+            env_vars.update(options['env_vars'])


+        # Merge user-defined env from metadata with any env_vars from options
+        env_vars = dict(metadata.env) if metadata.env else {}
+        if options.get('env_vars'):
+            env_vars.update(options['env_vars'])


+    # User-defined environment variables injected into sandbox pods
+    env: Optional[Dict[str, str]] = Field(
+        None, description="Extra env vars to inject into the agent container"
+    )


+        passed_env = call_kwargs.kwargs.get("env_vars") or call_kwargs[1].get("env_vars")
+        assert passed_env is not None
+        assert "LLM_BASE_URL" in passed_env
+        assert passed_env["LLM_BASE_URL"] == "http://llm"
+        assert passed_env["LLM_API_KEY"] == "sk-123"
+


Signed-off-by: madmecodes <ayushguptadev1@gmail.com>

hzxuzhonghu

/lgtm

Should we update document as well like docs/design/AgentRun-CLI-Design.md

volcano-sh-bot · 2026-05-11T08:38:01Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hzxuzhonghu

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~cmd/OWNERS~~ [hzxuzhonghu]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

hzxuzhonghu · 2026-05-11T08:38:44Z

LLM_API_KEY should better reference a secret key in k8s spec

warjiang · 2026-05-11T08:46:17Z

🚀 cool, need this feature ~

Copilot AI review requested due to automatic review settings May 10, 2026 18:00

volcano-sh-bot requested review from YaoZengzeng and acsoto May 10, 2026 18:00

volcano-sh-bot added the do-not-merge/invalid-commit-message label May 10, 2026

volcano-sh-bot added the size/L label May 10, 2026

Copilot started reviewing on behalf of madmecodes May 10, 2026 18:00 View session

gemini-code-assist Bot reviewed May 10, 2026

View reviewed changes

Copilot AI reviewed May 10, 2026

View reviewed changes

madmecodes force-pushed the feat/env-support-metadata branch from 74413a8 to c8f5957 Compare May 10, 2026 18:13

Copilot AI review requested due to automatic review settings May 10, 2026 18:21

madmecodes force-pushed the feat/env-support-metadata branch from c8f5957 to 4927514 Compare May 10, 2026 18:21

Copilot started reviewing on behalf of madmecodes May 10, 2026 18:22 View session

Copilot AI reviewed May 10, 2026

View reviewed changes

madmecodes force-pushed the feat/env-support-metadata branch from 4927514 to ba4a7ba Compare May 11, 2026 02:53

Add env support in agent_metadata.yaml

d8f9bc2

Signed-off-by: madmecodes <ayushguptadev1@gmail.com>

madmecodes force-pushed the feat/env-support-metadata branch from ba4a7ba to d8f9bc2 Compare May 11, 2026 07:09

volcano-sh-bot removed the do-not-merge/invalid-commit-message label May 11, 2026

hzxuzhonghu approved these changes May 11, 2026

View reviewed changes

volcano-sh-bot assigned hzxuzhonghu May 11, 2026

volcano-sh-bot added the lgtm label May 11, 2026

volcano-sh-bot added the approved label May 11, 2026

volcano-sh-bot merged commit abb1bf3 into volcano-sh:main May 11, 2026
14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cli): add env support in agent_metadata.yaml#315

feat(cli): add env support in agent_metadata.yaml#315
volcano-sh-bot merged 1 commit intovolcano-sh:mainfrom
madmecodes:feat/env-support-metadata

madmecodes commented May 10, 2026

Uh oh!

volcano-sh-bot commented May 10, 2026

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

gemini-code-assist Bot May 10, 2026

Uh oh!

gemini-code-assist Bot May 10, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

codecov-commenter commented May 10, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

hzxuzhonghu left a comment

Uh oh!

volcano-sh-bot commented May 11, 2026

Uh oh!

hzxuzhonghu commented May 11, 2026

Uh oh!

Uh oh!

warjiang commented May 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants


		with tempfile.TemporaryDirectory() as tmpdir:
		result = runtime.publish(Path(tmpdir), provider="agentcube")

		if options.get('env_vars'):
		env_vars.update(options['env_vars'])

Conversation

madmecodes commented May 10, 2026

Summary

What changed

Test plan

Uh oh!

volcano-sh-bot commented May 10, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot May 10, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot May 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

codecov-commenter commented May 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

hzxuzhonghu left a comment

Choose a reason for hiding this comment

Uh oh!

volcano-sh-bot commented May 11, 2026

Uh oh!

hzxuzhonghu commented May 11, 2026

Uh oh!

Uh oh!

warjiang commented May 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

codecov-commenter commented May 10, 2026 •

edited

Loading