Skip to content

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

Merged
mirzakopic merged 4 commits into
mainfrom
chore/update-operator-docs
May 26, 2026
Merged

docs: update platform-mesh-operator reference documentation#179
mirzakopic merged 4 commits into
mainfrom
chore/update-operator-docs

Conversation

@akafazov

@akafazov akafazov commented May 14, 2026

Copy link
Copy Markdown
Contributor

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

github-actions Bot commented May 14, 2026

Copy link
Copy Markdown
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-05-26 10:05 UTC

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

@mirzakopic mirzakopic 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.

Thanks for the major feature here

Comment thread how-to-guides/set-up-remote-deployment.md Outdated
Comment thread how-to-guides/set-up-remote-deployment.md Outdated
Comment thread how-to-guides/set-up-remote-deployment.md
| `kcp` | kcp workspace topology: provider connections, extra workspaces, API bindings |
| `values` | Free-form JSON passed as Helm values to the `platform-mesh-operator-components` chart |
| `infraValues` | Free-form JSON passed as Helm values to the `platform-mesh-operator-infra-components` chart |
| `values` | Free-form JSON deep-merged with the profile's `components` section and passed as Helm values to each service |

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.

What is deep-merged?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Rephrased to just merged.

The deep-merge is recursive — keys present in both are combined per nested level, and any leaf value in spec.values wins over the profile."

Comment thread reference/components/platform-mesh-operator.md
Comment thread how-to-guides/index.md
## Set up and run

- [Set up Platform Mesh locally](./set-up-platform-mesh-locally.md)
- [Set up remote deployment](./set-up-remote-deployment.md)

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.

The new how-to is added to the section landing page (how-to-guides/index.md) but not to this sidebar tree, so it won't appear in the left navigation.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

updated sidebar entry

referencePath:
- name: core
kcp:
adminSecretRef:

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

updated

On-behalf-of: @SAP angel.kafazov@sap.com
Signed-off-by: Angel Kafazov <akafazov@cst-bg.net>
@akafazov akafazov requested a review from mirzakopic May 26, 2026 09:16
@mirzakopic mirzakopic merged commit d72af61 into main May 26, 2026
5 checks passed
@mirzakopic mirzakopic deleted the chore/update-operator-docs branch May 26, 2026 10:05
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.

2 participants