Skip to content

[Automated] Draft docs (kagent): feat(ui): manage EgressPolicies from the UI - #726

Open
github-actions[bot] wants to merge 1 commit into
mainfrom
pr-tracker-draft-kagent-3542
Open

github-actions[bot] wants to merge 1 commit into
mainfrom
pr-tracker-draft-kagent-3542

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

The target's own content scan fails where the base build passed (docs-theme-extras markdown-leaks / built-html-integrity):

  • markdown-leaks.spec.ts > markdown-leaks: rendered HTML scan > no leaked markdown across built HTML pages

kagent-dev/kagent#3542 — feat(ui): manage EgressPolicies from the UI

Docs versions: main

No code-path rule covers 8 touched file(s). The planner could route these only by identifier search, so the candidate pages may miss what they changed, including in the other mode:

  • go/api/gen/kagent/api/v1/egress_policies.pb.go
  • go/api/gen/kagent/api/v1/egress_policies_grpc.pb.go
  • go/core/internal/grpcserver/egresspolicy.go
  • go/core/internal/grpcserver/policy.go
  • go/core/internal/grpcserver/server.go
  • go/core/internal/service/kubecrud/service.go
  • ...and 2 more

What changes for users: The kagent UI can now list, create, edit, and delete EgressPolicy resources from the Policies page. Users can inspect each policy's destinations and usage, select namespace-local policies from the Agent form, and reload before saving if an edit is based on a stale policy version.

What the docs now say: The Egress policies guide now expands the Manage policies in the UI section with the details page, Used by table, form validation, stale-save reload prompt, and Agent form selection behavior.

How kagent-3542 was drafted

Plan, and what changed it

  • Planned: Extend the EgressPolicy guide for the new UI policy-management workflow.
  • Learned: docs-site/content/kagent/main/agents/egress-policies.md already had a short UI section, so the specific edit belonged there rather than on the broader UI or networking pages.
  • Did: Extended the existing UI section with the user-visible behavior from the pull request.

Why a documentation change is necessary

The pull request adds an Egress Policies tab to the kagent UI, an EgressPolicy details page, create and edit forms, Agent form selection, and stale-save handling through the EgressPolicyService API. The target guide already documented EgressPolicy resources and had one UI paragraph, but that paragraph did not tell readers what the new UI pages show or how the form behaves. The new prose keeps the UI information beside the existing kubectl workflow for the same resource.

How to verify this change

  1. In the kagent repository's ui/ directory, set ENABLE_MOCK_UI=true in .env, run yarn dev, and open /policies. The Egress Policies tab lists policies with origins, authentication type, and Used by counts.
  2. Create a policy with a wildcard origin and authentication. The form blocks the save. Create a valid policy, and the details page shows the destinations and an empty Used by table.
  3. Edit an Agent in the same namespace and select the policy. After saving, the policy details page lists the Agent in Used by with Applied, and deleting the policy warns that one visible Agent or SandboxTemplate uses it.

Proposed release note

No proposed-release-note.md: markers.notes_placeable is false for this item.

Suggested text: The kagent UI now includes an Egress Policies tab on the Policies page. You can list, create, edit, and delete EgressPolicy resources, inspect destinations and usage, and select policies from the Agent form.

Files in this pull request

  • docs-site/content/kagent/main/agents/egress-policies.md
How the pages were chosen (triage report)

Draft a documentation change

kagent-dev/kagent#3542 — feat(ui): manage EgressPolicies from the UI

  • Product: kagent (upstream) → kagent-dev/website
  • Docs version: main
  • Code issue: [FEATURE] UI: Policies page for EgressPolicy kagent#3526
  • Summary (read from the body): 🤖 written by Claude (start)
  • Not tested: no cluster was available, so every command in this diff is unrun
  • No rule covers 8 touched file(s). The candidate pages below come from the files that DID match a rule, so they may scope this narrower than the change is. Read these before deciding the change is only about the pages listed:
    • go/api/gen/kagent/api/v1/egress_policies.pb.go
    • go/api/gen/kagent/api/v1/egress_policies_grpc.pb.go
    • go/core/internal/grpcserver/egresspolicy.go
    • go/core/internal/grpcserver/policy.go
    • go/core/internal/grpcserver/server.go
    • go/core/internal/service/kubecrud/service.go
    • ...and 2 more

Draft branch: pr-tracker-draft-kagent-3542


Important

The test suite has not run on this pull request. It was opened by github-actions[bot], and GitHub does not start workflows for pull requests opened with the repository's own token. This repository's checks are held as action_required until somebody presses Approve and run on the Checks tab. Checks that come from GitHub Apps rather than Actions, such as DCO, run on their own.

Please approve the checks before reviewing the content: an absence of failures here means the tests have not run, not that they passed.

… the UI

Signed-off-by: GitHub Action <action@github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant