Skip to content

document DeploymentSettings and AgentConfiguration singleton setup#610

Open
zreigz wants to merge 2 commits into
mainfrom
lukasz/prod-4282-ensure-deploymentsettings-and-agentconfiguration-singleton
Open

document DeploymentSettings and AgentConfiguration singleton setup#610
zreigz wants to merge 2 commits into
mainfrom
lukasz/prod-4282-ensure-deploymentsettings-and-agentconfiguration-singleton

Conversation

@zreigz

@zreigz zreigz commented Jun 26, 2026

Copy link
Copy Markdown
Member

Plural Flow: docs
Plural Preview: docs

@zreigz zreigz requested a review from a team as a code owner June 26, 2026 10:45

@plural-copilot plural-copilot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Deploy preview for docs-pr-610 is ready!

Name Details
⚡ Service docs-pr-610 (5 / 5 ready)
☁️ Cluster plural (eks)
:octocat: Commit sha 52872e3
Plural URL https://console.mgmt.plural.sh/cd/clusters/446acdef-8524-425a-a49f-5336a...
🔍 Logs URL https://console.mgmt.plural.sh/cd/clusters/446acdef-8524-425a-a49f-5336a...
🌊 Flow URL https://console.mgmt.plural.sh/flows/08a17af1-8578-449e-9ae1-28ccd97eafc...
Preview Link Preview

You can learn more about preview environments and Plural Flows here

@linear

linear Bot commented Jun 26, 2026

Copy link
Copy Markdown

PROD-4282

@greptile-apps

greptile-apps Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR restructures the Continuous Deployment section by splitting the single deployment-operator.md page into two new sub-sections — management-controller (documenting the DeploymentSettings singleton CRD) and deployment-operator (documenting the AgentConfiguration singleton CRD) — and adds the corresponding navigation entries, redirects, and generated routes.

  • New docs: management-controller/deployment-settings.md and deployment-operator/agent-configuration.md each cover singleton-resource semantics, spec field references, YAML examples, and verification steps; a comparison table in agent-configuration.md cleanly distinguishes the two CRDs.
  • Bug fix: sandboxing.md corrects the AgentConfiguration example from name: global / namespace: plrl-deploy-operator (the wrong identity, inherited from DeploymentSettings) to name: default with no namespace, matching the cluster-scoped singleton contract.
  • Routing: docs-structure.ts adds the new nav sections and a permanent: true redirect from /deployment-operator/deployment-settings to the canonical management-controller URL; routes.json includes a conflicting direct-route entry for the same redirected path.

Confidence Score: 4/5

Safe to merge; the documentation content is accurate and the sandboxing.md bug fix is correct. The routes.json conflict is cosmetic and unlikely to affect real users at runtime.

The documentation content is accurate and the sandboxing.md bug fix is correct. The two issues found are non-blocking: a dead route entry in routes.json and a potentially misleading '0s' duration in the full example.

generated/routes.json (dead route entry at line 554) and pages/plural-features/continuous-deployment/deployment-operator/agent-configuration.md (full example with pipelineGateInterval: '0s')

Important Files Changed

Filename Overview
pages/plural-features/continuous-deployment/deployment-operator/agent-configuration.md New page documenting the AgentConfiguration CRD; well-structured, but the full example disables pipeline gate evaluation by setting pipelineGateInterval to "0s"
pages/plural-features/continuous-deployment/management-controller/deployment-settings.md New page documenting the DeploymentSettings CRD; singleton name/namespace requirements, spec reference, and verification steps are all clear and accurate
generated/routes.json Adds routes for new pages, but includes a route for /deployment-operator/deployment-settings that conflicts with a permanent redirect defined for the same path in docs-structure.ts
pages/getting-started/advanced-config/sandboxing.md Fixes the AgentConfiguration example: corrects name from "global" to "default" and removes the invalid namespace (resource is cluster-scoped)
pages/plural-features/continuous-deployment/deployment-operator/index.md New index page for the deployment-operator section, replacing the deleted flat file; links and cross-references are accurate
pages/plural-features/continuous-deployment/management-controller/index.md New index page for the management-controller section; clear overview with correct cross-links to DeploymentSettings and reconciliation logic docs
src/routing/docs-structure.ts Adds new sections to the nav tree and a permanent redirect for /deployment-operator/deployment-settings; the redirect source matches a stale route entry in routes.json

Reviews (1): Last reviewed commit: "ensure DeploymentSettings and AgentConfi..." | Re-trigger Greptile

Comment thread generated/routes.json

@Deniwn22 Deniwn22 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Logic looks correct. One suggestion: the early return on line prevents the cleanup function from running — worth adding a finally block.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants