Update dataplane cr definition to support cluster agent access#141
Conversation
|
|
||
| OpenChoreo supports two modes of communication with the DataPlane: | ||
| - **Agent-based** (Recommended): The control plane communicates with the downstream cluster through a WebSocket agent running in the DataPlane cluster | ||
| - **Direct Kubernetes API access** (Deprecated): The control plane connects directly to the Kubernetes API server using client certificates or bearer tokens. This mode is deprecated and will be removed in a future release. |
There was a problem hiding this comment.
Are we deprecating this? What I was thinking is to keep this and supporting the new cluster-agent based method as the default one, in that way I think we have more flexibility. For example if there is someone who already using Tailscale like VPN to access dataplane, we still can support it through this this method. WDYT?
There was a problem hiding this comment.
IMO we can go ahead with cluster gateway and remove the direct access. Even with the VPN this can be achieved
|
|
||
| OpenChoreo supports two modes of communication with the DataPlane: | ||
| - **Agent-based** (Recommended): The control plane communicates with the downstream cluster through a WebSocket agent running in the DataPlane cluster | ||
| - **Direct Kubernetes API access** (Deprecated): The control plane connects directly to the Kubernetes API server using client certificates or bearer tokens. This mode is deprecated and will be removed in a future release. |
There was a problem hiding this comment.
Should we remove this? This will still make sense for single-cluster setups.
There was a problem hiding this comment.
We will go ahead with cluster gateway architecture going forward and not with the direct access
There was a problem hiding this comment.
For local setups, wouldn’t it be better to keep this?
Ex: quick-start?
There was a problem hiding this comment.
Its better to have a one correct way to do a specific task. I can agree to remove deprecation flag for now. WDYT?
There was a problem hiding this comment.
Shall we do that? we can discuss and decide this later.
There was a problem hiding this comment.
Removed deprecation notice
4 participants
Purpose
This pull request updates the DataPlane API documentation to clarify communication modes, deprecate direct Kubernetes API access, and improve configuration examples. The changes emphasize agent-based communication as the recommended approach and introduce new configuration fields for secrets and external integrations. Deprecated fields and modes are clearly marked, and examples have been expanded for better guidance.
Communication Modes and Deprecation Notices
Spec Field Updates and New Configurations
registryfield, addedagent,imagePullSecretRefs, andsecretStoreReffields, and markedkubernetesClusteras deprecated and optional when agent-based communication is enabled. Provided new configuration sections for agent-based communication and secret management.Examples and Usage Patterns
Related Issues
Checklist
sidebars.tsif adding a new documentation pagenpm run startto preview the changes locallynpm run buildto ensure the build passes without errors