Add install method context table to SDK overview#4177
Merged
Conversation
The SDK overview didn't explain how the SDK's role and behavior differ across Helm CLI, KOTS, EC v2, EC v3, and airgap installs. This adds a table covering each context. sc-137086 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| ## How the SDK works across installation methods | ||
|
|
||
| The Replicated SDK is deployed as a standard Kubernetes Deployment and Service. Its role and behavior vary depending on the installation method: |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('is deployed').
| | Installation Method | SDK Role | Notable Behavior | | ||
| |---|---|---| | ||
| | **Helm CLI** | Only Replicated component in the cluster | Registers the instance, creates image pull secrets, and sends all telemetry to the Vendor Portal | | ||
| | **KOTS** | Runs alongside the KOTS admin console | Both the SDK and KOTS report telemetry independently. Reports are linked by the `KotsInstallID` header | |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('are linked').
| | **KOTS** | Runs alongside the KOTS admin console | Both the SDK and KOTS report telemetry independently. Reports are linked by the `KotsInstallID` header | | ||
| | **Embedded Cluster v2** | Runs alongside KOTS and the EC operator | Same as KOTS, plus reports Embedded Cluster-specific data (cluster ID, version, and node count) | | ||
| | **Embedded Cluster v3** | Runs alongside the EC daemon | Reports Embedded Cluster-specific data. The EC daemon handles registry authentication using a service account token | | ||
| | **Airgap (any method)** | Runs locally without internet access | Serves license and app info from cached values. Stores telemetry in a Kubernetes Secret for collection via support bundles. Update checks and instance tags are unavailable. See [Air Gap Installations with the SDK](/vendor/replicated-sdk-airgap) | |
Contributor
There was a problem hiding this comment.
[Replicated.WordSwaps] Use 'with' or 'through' instead of 'via'.
sgalsaleh
previously approved these changes
Jun 15, 2026
Per eng review: the header name is too much implementation detail for customer-facing docs. Replaced with "correlated server-side". Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
| | Installation Method | SDK Role | Notable Behavior | | ||
| |---|---|---| | ||
| | **Helm CLI** | Only Replicated component in the cluster | Registers the instance, creates image pull secrets, and sends all telemetry to the Vendor Portal | | ||
| | **KOTS** | Runs alongside the KOTS admin console | Both the SDK and KOTS report telemetry independently. Reports are correlated server-side | |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('are correlated').
sgalsaleh
approved these changes
Jun 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Preview: https://deploy-preview-4177--replicated-docs-upgrade.netlify.app/vendor/replicated-sdk-overview#how-the-sdk-works-across-installation-methods
Summary
Related: sc-137086
Test plan
/vendor/replicated-sdk-airgapresolves🤖 Generated with Claude Code