Skip to content

Commit de2e96c

Browse files
mhotanclaude
andcommitted
Add consolidation comments and deprecation notices
Add notes to selfhosted-intracluster values overlay files indicating that common (non-cloud-specific) configuration is being migrated to values.yaml over time. Add deprecation notices to SELFHOSTED_INTRA_CLUSTER docs pointing to the new canonical docs on the Union documentation site. Update controlplane README.md to reference the docs site. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 42b4070 commit de2e96c

7 files changed

Lines changed: 29 additions & 17 deletions

‎charts/controlplane/README.md‎

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -343,25 +343,13 @@ kubectl delete namespace union-cp
343343

344344
## Alternative Deployment Models
345345

346-
### Self-Hosted Intra-Cluster Deployment (AWS)
346+
### Self-Hosted Intra-Cluster Deployment
347347

348-
For deploying Union control plane in the **same Kubernetes cluster** as your Union dataplane, see the dedicated guide:
348+
For deploying Union control plane in the **same Kubernetes cluster** as your Union dataplane, see the [Self-hosted deployment guide](https://docs.union.ai/selfmanaged/deployment/selfhosted-deployment/) on the Union documentation site.
349349

350-
**[Self-Hosted Intra-Cluster Deployment Guide (AWS)](SELFHOSTED_INTRA_CLUSTER_AWS.md)**
351-
352-
This deployment model is ideal for:
353-
354-
- Fully self-hosted Union deployments
355-
- Single-cluster architectures with co-located control plane and dataplane
356-
- Environments requiring simplified networking and reduced costs
357-
- Deployments with strict data sovereignty requirements
358-
359-
The intra-cluster guide covers:
360-
361-
- TLS certificate generation for intra-cluster communication
362-
- Single-tenant mode configuration
363-
- Service discovery between control plane and dataplane
364-
- Complete end-to-end setup for both control plane and dataplane
350+
Reference guides are also available in this repository:
351+
- [AWS](SELFHOSTED_INTRA_CLUSTER_AWS.md)
352+
- [GCP](SELFHOSTED_INTRA_CLUSTER_GCP.md)
365353

366354
---
367355

‎charts/controlplane/SELFHOSTED_INTRA_CLUSTER_AWS.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
> **Note**: This guide has been migrated to the Union.ai documentation site.
2+
> See: https://docs.union.ai/selfmanaged/deployment/selfhosted-deployment/
3+
> This file is kept for reference but may not be updated.
4+
15
# Self-Hosted Intra-Cluster Deployment Guide (AWS)
26

37
This guide covers deploying Union control plane in the **same Kubernetes cluster** as your Union dataplane (co-located deployment). This is ideal for fully self-hosted Union deployments where both control plane and dataplane run in your infrastructure.

‎charts/controlplane/SELFHOSTED_INTRA_CLUSTER_GCP.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
> **Note**: This guide has been migrated to the Union.ai documentation site.
2+
> See: https://docs.union.ai/selfmanaged/deployment/selfhosted-deployment/
3+
> This file is kept for reference but may not be updated.
4+
15
# Self-Hosted Intra-Cluster Deployment Guide (GCP)
26

37
This guide covers deploying Union control plane in the **same Kubernetes cluster** as your Union dataplane (co-located deployment). This is ideal for fully self-hosted Union deployments where both control plane and dataplane run in your infrastructure.

‎charts/controlplane/values.aws.selfhosted-intracluster.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@
1313
# - Single-tenant mode with explicit organization configuration
1414
# - Direct communication between control plane and dataplane services
1515
# - Includes all AWS-specific configuration (RDS, S3, IAM roles)
16+
#
17+
# NOTE: Common configuration that is not cloud-specific is being migrated
18+
# to values.yaml over time (e.g. selfServeConfig.legacyHosts). Cloud-specific
19+
# overrides (storage, IAM, regions) will remain in this file.
1620
# ============================================================================
1721

1822
# ----------------------------------------------------------------------------

‎charts/controlplane/values.gcp.selfhosted-intracluster.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@
1212
# - Requires TLS certificates for gRPC/HTTP2 with NGINX
1313
# - Single-tenant mode with explicit organization configuration
1414
# - Direct communication between control plane and dataplane services
15+
#
16+
# NOTE: Common configuration that is not cloud-specific is being migrated
17+
# to values.yaml over time (e.g. selfServeConfig.legacyHosts). Cloud-specific
18+
# overrides (storage, IAM, regions) will remain in this file.
1519
# - Includes all GCP-specific configuration (CloudSQL, GCS, GCP service accounts)
1620
# ============================================================================
1721

‎charts/dataplane/SELFHOSTED_INTRA_CLUSTER_AWS.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
> **Note**: This guide has been migrated to the Union.ai documentation site.
2+
> See: https://docs.union.ai/selfmanaged/deployment/selfhosted-deployment/
3+
> This file is kept for reference but may not be updated.
4+
15
# Self-Hosted Intra-Cluster Deployment Guide (AWS)
26

37
This guide covers deploying Union dataplane in the **same Kubernetes cluster** as your Union control plane (co-located deployment). This is ideal for fully self-hosted Union deployments where both control plane and dataplane run in your infrastructure.

‎charts/dataplane/SELFHOSTED_INTRA_CLUSTER_GCP.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
> **Note**: This guide has been migrated to the Union.ai documentation site.
2+
> See: https://docs.union.ai/selfmanaged/deployment/selfhosted-deployment/
3+
> This file is kept for reference but may not be updated.
4+
15
# Self-Hosted Intra-Cluster Deployment Guide (GCP)
26

37
This guide covers deploying Union dataplane in the **same Kubernetes cluster** as your Union control plane (co-located deployment). This is ideal for fully self-hosted Union deployments where both control plane and dataplane run in your infrastructure.

0 commit comments

Comments
 (0)