Move info about port forwarding the SDK API service #2900
Conversation
replicated-ci
added
type::docs
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
|
||
| <IntegrationMode/> | ||
|
|
||
| ## Port Forwarding the SDK API Service {#port-forward} |
There was a problem hiding this comment.
Moved the port forwarding procedure to its own section of "Developing Against the SDK API".
Originally, I had this as just the last two steps in the integration mode procedure, but then I wasn't sure if maybe people would want to know how to do this outside of integration mode & also if it might be helpful to have a direct anchor link to the port forwarding steps that we could send to people
| This topic describes the methods for distributing and installing the Replicated SDK. | ||
|
|
||
| It includes information about how to install the SDK alongside Helm chart- or standard manifest-based applications using the Helm CLI or Replicated KOTS. It also includes information about installing the SDK separately from an application as a standalone component in integration mode. | ||
| It includes information about how to install the SDK alongside Helm charts or Kubernetes manifest-based applications using the Helm CLI or a Replicated installer (Replicated KOTS, kURL, Embedded Cluster). It also includes information about installing the SDK as a standalone component in integration mode. |
There was a problem hiding this comment.
^ Updating some dated language. Removing "standard" manifest in favor or k8s manifest. Also, the "Replicated installer" thing is the current way to talk about kots, kurl, ec
| You can use the Replicated SDK in integration mode to develop locally against the SDK API without needing to add the SDK to your application, create a release in the Replicated Vendor Portal, or make changes in your environment. You can also use integration mode to test sending instance data to the Vendor Portal, including any custom metrics that you configure. | ||
| To use integration mode, install the Replicated SDK as a standalone component using a valid development license. For more information, see [Developing Against the SDK API](/vendor/replicated-sdk-development). | ||
| <IntegrationMode/> |
There was a problem hiding this comment.
^ put the partial here so that people could see the steps rather than having to click away
| 'vendor/replicated-sdk-overview', | ||
| 'vendor/replicated-sdk-installing', | ||
| 'vendor/replicated-sdk-airgap', | ||
| 'vendor/replicated-sdk-development', |
There was a problem hiding this comment.
Moved this up to main SDK section
|
|
||
| To use integration mode, install the Replicated SDK as a standalone component using a valid Development license created in the Vendor Portal. After you install in integration mode, the SDK provides default mock data for requests to the SDK API `app` endpoints. Requests to the `license` endpoints use the real data from your Development license. | ||
|
|
||
| To install the SDK in integration mode: |
There was a problem hiding this comment.
made these steps a partial so they could be included in both the Developing Against the SDK API and the Installing the SDK topics. Both seemed reasonable places to look for this info
No description provided.