Skip to content

Add cloud documentation for health probe configuration feature - #31

Draft
Jithmi004 wants to merge 1 commit into
wso2:mainfrom
Jithmi004:probe-configurable-fix-docs-cloud
Draft

Jithmi004 wants to merge 1 commit into
wso2:mainfrom
Jithmi004:probe-configurable-fix-docs-cloud

Conversation

@Jithmi004

@Jithmi004 Jithmi004 commented Oct 15, 2026 •

Copy link
Copy Markdown

Purpose

Agent Manager's health checks (startup, readiness and liveness) on platform-hosted agents are becoming configurable in wso2/agent-manager#1997. This PR documents them for Agent Manager Cloud.

Goals

  • Explain the three health checks, their defaults and the two check types (TCP and HTTP GET).
  • Show where to set them: the Readiness Check choice on the create page, and the Health Checks card in Configure Build.
  • Explain how a change reaches an environment. A deploy applies it to the first environment in the pipeline, and promoting that release carries it to later environments.
  • Show where to see an environment's checks on the Deploy page.
  • Cover agents created from the Agent Catalog. A published version saves the checks it had, and its agents start with them.

Approach

  • New guide versioned_docs/version-cloud/guides/configure-agent-health-checks.mdx, added to versioned_sidebars/version-cloud-sidebars.json under Guides → Platform Administration.
  • Short updates to related pages in versioned_docs/version-cloud/:
    • concepts/agent-kind-and-catalog.mdx: a published version saves the source agent's health checks.
    • concepts/agent-lifecycle.mdx: health checks added to "What Makes Up an Agent", and the readiness wording now links to the guide.
    • guides/deploy-an-a2a-agent.mdx: an optional step to use HTTP GET on /.well-known/agent-card.json for readiness.
    • tutorials/create-your-first-agent.mdx: leave Readiness Check on TCP, with a link to the guide.
  • The content matches the Next version of these docs (see Related PRs). All Console labels, defaults and limits were checked against the probe-configurable-fix branch of wso2/agent-manager.
  • Only the Cloud version (versioned_docs/version-cloud/) changes. The Next docs are in a separate PR.

User stories

  • As an agent developer, I can make my agent receive traffic only when it can actually answer, by pointing its readiness check at a health endpoint.
  • As an agent developer, I can give a slow-starting agent more time to start, and turn on a liveness check so a stuck agent is restarted.
  • As an agent developer, I can see which health checks each environment runs.

Release note

Documented configurable health checks for platform-hosted agents in Agent Manager Cloud: startup, readiness and liveness checks, how to set them, and how changes reach each environment.

Documentation

This PR is the documentation. New page: versioned_docs/version-cloud/guides/configure-agent-health-checks.mdx.

Training

N/A. Documentation-only change.

Certification

N/A. Documentation-only change with no impact on certification exams.

Marketing

N/A

Automation tests

  • Unit tests

    N/A. Documentation only.

  • Integration tests

    N/A. npm run build passes, and it fails on broken links, the same check CI runs.

Security checks

Samples

N/A

Related PRs

Migrations (if applicable)

N/A

Test environment

Built with npm run build (Docusaurus) on macOS.

Learning

N/A

@coderabbitai

coderabbitai Bot commented Oct 15, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

This branch has not been deployed

No deployments
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.

[Task]: Add Documentation for health probe configuration feature

1 participant