Skip to content

docs: update platform-mesh-operator reference documentation#179

Open
akafazov wants to merge 3 commits into
mainfrom
chore/update-operator-docs
Open

docs: update platform-mesh-operator reference documentation#179
akafazov wants to merge 3 commits into
mainfrom
chore/update-operator-docs

Conversation

@akafazov
Copy link
Copy Markdown
Contributor

@akafazov akafazov commented May 14, 2026

Title: docs: update platform-mesh-operator reference documentation

Body:

Summary

  • Update operator reference to reflect current architecture: Go template rendering replaces the old Helm sub-chart approach
  • Add Profile ConfigMap section explaining the linkage between PlatformMesh CR and profile (naming convention or spec.profileConfigMap)
  • Add Configuration and values flow section: profile provides broad config, spec.values provides overrides, merged values are passed 1-to-1 to HelmRelease/ArgoCD Application per service
  • Add deployment technologies section (FluxCD / ArgoCD)
  • Add remote deployment section: cluster roles, how to enable, effect on downstream resources, known limitation (single remote deployment per operator instance)
  • Add remote deployment flags to operator flags table (--remote-runtime-kubeconfig, --remote-infra-kubeconfig, etc.)
  • Update ResourceReconciler docs to cover ArgoCD mode (chart/image artifact handling)
  • Update integration diagram to show ArgoCD and template rendering
  • Remove outdated references (DEPLOYMENT_KUBECONFIG env var, old Helm chart names)

Test plan

  • Verify docs site builds without errors
  • Review rendered page for formatting and link correctness
  • Cross-reference with platform-mesh-operator README for consistency

refers to platform-mesh/helm-charts#1607

@akafazov akafazov changed the title feat: update operator docs docs: update platform-mesh-operator reference documentation May 14, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 14, 2026

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://platform-mesh.github.io/pr-preview/pr-179/

Built to branch gh-pages at 2026-05-14 15:59 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

akafazov added 3 commits May 14, 2026 11:58
On-behalf-of: @SAP angel.kafazov@sap.com
Signed-off-by: Angel Kafazov <akafazov@cst-bg.net>
On-behalf-of: @SAP angel.kafazov@sap.com
Signed-off-by: Angel Kafazov <akafazov@cst-bg.net>
On-behalf-of: @SAP angel.kafazov@sap.com
Signed-off-by: Angel Kafazov <akafazov@cst-bg.net>
@akafazov akafazov force-pushed the chore/update-operator-docs branch from 53f4d75 to 81c3f85 Compare May 14, 2026 15:58
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