docs(multi-region): document management API access pattern#2152
docs(multi-region): document management API access pattern#2152rlmcpherson wants to merge 1 commit into
Conversation
In a multi-region platform deployment, the v1.management.loft.sh APIService is registered locally inside each region's embedded API server rather than aggregated on the host EKS cluster. Document the endpoint shape, authentication via platform access key, and worked examples for kubectl, curl, and Argo CD. Include a 4.7.x to 4.8.0 upgrade note and a troubleshooting table for the common failure modes. Add cross-link callouts on the access keys and Argo CD integration pages so readers find the section from adjacent contexts. Closes ENGPLAT-649
✅ Deploy Preview for vcluster-docs-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| therefore registers the APIService locally, and the platform's own HTTPS | ||
| endpoint is the integration surface. | ||
|
|
||
| ### Standard vs. multi-region behavior |
There was a problem hiding this comment.
[Google.Headings] 'Standard vs. multi-region behavior' should use sentence-style capitalization.
| | Aspect | Standard platform | Multi-region platform | | ||
| | --- | --- | --- | | ||
| | `v1.management.loft.sh` location | Aggregated APIService on the host EKS cluster | Local APIService inside each region's embedded API server | | ||
| | Endpoint | `${EKS_ENDPOINT}/apis/management.loft.sh/v1/...` | `https://<platform-url>/kubernetes/management/apis/management.loft.sh/v1/...` | |
There was a problem hiding this comment.
[Google.Ellipses] In general, don't use an ellipsis.
| [creating an access key](../../authentication/access-keys.mdx#create-an-access-key), | ||
| scope it to the project, user, or tenant cluster the caller needs. | ||
|
|
||
| #### kubectl |
There was a problem hiding this comment.
[Google.Headings] 'kubectl' should use sentence-style capitalization.
| language="bash" | ||
| /> | ||
|
|
||
| #### curl |
There was a problem hiding this comment.
[Google.Headings] 'curl' should use sentence-style capitalization.
| language="bash" | ||
| /> | ||
|
|
||
| #### Argo CD declarative cluster |
There was a problem hiding this comment.
[Google.Headings] 'Argo CD declarative cluster' should use sentence-style capitalization.
| For the wider Argo CD integration (project import, SSO, AppProject sync), see | ||
| [Argo CD integration](../../../integrations/argocd.mdx). | ||
|
|
||
| ### Upgrading from 4.7.x to 4.8.0 |
There was a problem hiding this comment.
[Loft.imperative-headings] Headings should start with an imperative verb. 'Upgrading' appears to be a present participle (ends with 'ing').
| Standard (non-multi-region) platform deployments are unaffected. The host EKS | ||
| APIService keeps working as before. | ||
|
|
||
| ### Troubleshooting |
There was a problem hiding this comment.
[Loft.imperative-headings] Headings should start with an imperative verb. 'Troubleshooting' appears to be a present participle (ends with 'ing').
|
|
||
| | Symptom | Cause | Resolution | | ||
| | --- | --- | --- | | ||
| | `404` from `${EKS_ENDPOINT}/apis/management.loft.sh/...` | Caller is using the host EKS endpoint on a multi-region platform | Switch to `https://<platform-url>/kubernetes/management/...` | |
There was a problem hiding this comment.
[Google.Ellipses] In general, don't use an ellipsis.
1 participant
Summary
InterpolatedCodeBlock), a 4.7.x → 4.8.0 upgrade note, and a troubleshooting matrix.Why
Upgrading to 4.8.0 on a multi-region platform, found that automation calling
${EKS_ENDPOINT}/apis/management.loft.sh/...silently broke. The routing change that landed in loft-sh/loft-enterprise#6274 (ENGPLAT-87) only affects embedded-k8s / multi-region deployments, but there was no migration guidance in the 4.8.0 release notes or on the multi-region admin page. This PR closes that documentation gap.Test plan
npm run validate-glossary— clean locally.npm run build(Netlify CI) — verify the new section renders, internal links resolve, and the InterpolatedCodeBlock snippets parse.References
Closes ENGPLAT-649