Move info about port forwarding the SDK API service

paigecalvert · paigecalvert · commit 1706f8dd1b4c · 2024-12-12T11:43:02.000-07:00
diff --git a/docs/partials/replicated-sdk/_kots-version-req.mdx b/docs/partials/replicated-sdk/_kots-version-req.mdx
@@ -1 +1 @@
-To install the SDK with KOTS, KOTS v1.104.0 or later and the SDK version 1.0.0-beta.12 or later are required. You can verify the version of KOTS installed with `kubectl kots version`.
+To install the SDK with a Replicated installer, KOTS v1.104.0 or later and the SDK version 1.0.0-beta.12 or later are required. You can verify the version of KOTS installed with `kubectl kots version`. For Replicated Embedded Cluster installations, you can see the version of KOTS that is installed by your version of Embedded Cluster in the [Embedded Cluster Release Notes](/release-notes/rn-embedded-cluster).
diff --git a/docs/reference/replicated-sdk-apis.md b/docs/reference/replicated-sdk-apis.md
@@ -6,31 +6,6 @@ For example, if your application includes a UI where users manage their applicat
 
 For more information about how to get started with the Replicated SDK, see [About the Replicated SDK (Beta)](/vendor/replicated-sdk-overview).
 
-## Use Port Forwarding to Access the SDK API
-
-After the Replicated SDK is installed and initialized in a cluster, the Replicated SDK API is exposed at `replicated:3000`. You can access the SDK API for testing by forwarding port 3000 to your local machine.
-
-To use port forwarding to access the SDK API:
-
-1. Install the SDK in your cluster. See [Installing the Replicated SDK](/vendor/replicated-sdk-installing).
-
-1. Run the following command to port forward to the SDK API service:
-
-    ```bash
-    kubectl port-forward service/replicated 3000
-    ```
-    ```
-    Forwarding from 127.0.0.1:3000 -> 3000
-    Forwarding from [::1]:3000 -> 3000
-    ```
-
-1. With the port forward running, test the SDK API endpoints as desired. For example:
-
-   ```bash
-   curl localhost:3000/api/v1/license/fields/expires_at
-   curl localhost:3000/api/v1/license/fields/{field}
-   ```
-
 ## app
 
 ### GET /app/info
diff --git a/docs/vendor/replicated-sdk-development.md b/docs/vendor/replicated-sdk-development.md
@@ -1,64 +1,78 @@
 # Developing Against the SDK API (Beta)
 
-This topic describes how to enable integration mode for the Replicated SDK to develop and test changes locally. For more information about the SDK API, see [Replicated SDK API (Beta)](/reference/replicated-sdk-apis).
+This topic describes how to use integration mode for the Replicated SDK to develop and test changes locally. For more information about the SDK API, see [Replicated SDK API (Beta)](/reference/replicated-sdk-apis).
 
-## About Integration Mode
+## Overview
 
 You can use the Replicated SDK in integration mode to develop locally against the SDK API without needing to make real changes in the Replicated Vendor Portal or in your environment.
 
-To use integration mode, install the Replicated SDK as a standalone component using a valid development license created in the Replicated 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 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 use the Replicated SDK in integration mode, complete the following procedures:
-1. [Create a Development License](#license)
-1. [Install the SDK in integration mode](#install)
+To develop against the SDK API:
 
-## Create a Development License {#license}
+1. Create a Development license that you can use to install the SDK in integration mode:
 
-To use integration mode, you first need to create a development license that you can use to install the SDK. When you create the development license, you can add values to any license fields that you want to use in testing.
+   1. In the Vendor Portal, go to **Customers** and click **Create customer**.
 
-For information about development licenses, see [License Types](licenses-about#license-types) in _About Licenses_.
+   1. Complete the following fields:
+      
+      1. For **Customer name**, add a name for the customer.
+      
+      1. For **Assigned channel**, assign the customer to the channel that you use for testing. For example, Unstable.
+      
+      1. For **Customer type**, select **Development**.
+      
+      1. For **Customer email**, add the email address that you want to use for the license.
 
-To create a development license:
+      1. For **Install types**, ensure that the **Existing Cluster (Helm CLI)** option is enabled.
 
-1. In the Vendor Portal, go to **Customers** and click **Create customer**.
+      1. (Optional) Add any license field values that you want to use for testing:
 
-1. Complete the following fields:
-    
-    1. For **Customer name**, add a name for the customer.
-    
-    1. For **Assigned channel**, assign the customer to the channel that you use for testing. For example, Unstable.
-    
-    1. For **Customer type**, select **Development**.
-    
-    1. For **Customer email**, add the email address that you want to use for the license.
+         1. For **Expiration policy**, you can add an expiration date for the license. 
 
-   ![create customer page in the Vendor Portal](/images/create-customer-development-mode.png)
-   [View a larger version of this image](/images/create-customer-development-mode.png)
+         1. For **Custom fields**, you can add values for any custom license fields in your application. For information about how to create custom license fields, see [Managing Customer License Fields](/vendor/licenses-adding-custom-fields).
 
-1. (Optional) Add any license field values that you want to use for testing:
+   1. Click **Save Changes**.
 
-   1. For **Expiration policy**, you can add an expiration date for the license. 
+1. On the **Manage customer** page for the customer you created, click **Helm install instructions**.
 
-   1. For **Custom fields**, you can add values for any custom license fields in your application. For information about how to create custom license fields, see [Managing Customer License Fields](/vendor/licenses-adding-custom-fields).
+   <img alt="Helm install instructions button on the manage customer page" src="/images/helm-install-instructions-button.png" width="700px"/>
 
-1. Click **Save Changes**.
+   [View a larger version of this image](/images/helm-install-instructions-button.png)
 
-## Install the SDK in Integration Mode {#install}
+1. In the **Helm install instructions** dialog, copy and run the command to log in to the Replicated registry.
 
-To develop against the SDK locally in your development environment, install the SDK in integration mode as a standalone component in your cluster.
+   <img alt="Registry login command in the Helm install instructions dialog" src="/images/helm-install-instructions-registry-login.png" width="600px"/>
 
-To install the SDK in integration mode:
+   [View a larger version of this image](/images/helm-install-instructions-registry-login.png)
 
-1. On the **Manage customer** page for the customer you created, click **Helm install instructions**.
+1. From the same dialog, copy and run the command to install the SDK in integration mode:
 
-   ![Helm install instructions button on the manage customer page](/images/helm-install-instructions-button.png)
+   <img alt="SDK integration mode install command in the Helm install instructions dialog" src="/images/helm-install-instructions-sdk-integration.png" width="600px"/>
 
-1. In the **Helm install instructions** dialog, copy and run the command to log in to the Replicated registry.
+   [View a larger version of this image](/images/helm-install-instructions-sdk-integration.png)
 
-   ![Registry login command in the Helm install instructions dialog](/images/helm-install-instructions-registry-login.png)
+   After the Replicated SDK is installed and initialized in a cluster, the Replicated SDK API is exposed at `replicated:3000`. You can access the SDK API for testing by forwarding port 3000 to your local machine.
 
-1. From the same dialog, copy and run the command to install the SDK in integration mode:
+1. Run the following command to port forward to the SDK API service:
+
+    ```bash
+    kubectl port-forward service/replicated 3000
+    ```
+    ```
+    Forwarding from 127.0.0.1:3000 -> 3000
+    Forwarding from [::1]:3000 -> 3000
+    ```
+
+1. With the port forward running, test the SDK API endpoints as desired. For example:
 
-   ![SDK integration mode install command in the Helm install instructions dialog](/images/helm-install-instructions-sdk-integration.png)
+   ```bash
+   curl localhost:3000/api/v1/license/fields/expires_at
+   curl localhost:3000/api/v1/license/fields/{field}
+   ```
+   
+   For more information about using the SDK API, see [Replicated SDK API (Beta)](/reference/replicated-sdk-apis).
 
-1. Make requests to the SDK API from your application. Requests to the `license` endpoints use your actual development license data, while requests to the `app` endpoints use the default mock data. For more information about using the SDK API, see [Replicated SDK API (Beta)](/reference/replicated-sdk-apis).
+   :::note
+   Requests to the `license` endpoints use your actual development license data, while requests to the `app` endpoints use the default mock data.
+   :::
diff --git a/docs/vendor/replicated-sdk-installing.mdx b/docs/vendor/replicated-sdk-installing.mdx
@@ -6,7 +6,7 @@ import RegistryLogout from "../partials/replicated-sdk/_registry-logout.mdx"
 
 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.
 
 For information about installing the SDK in air gap mode, see [Installing the SDK in Air Gap Environments](replicated-sdk-airgap).
 
@@ -65,13 +65,13 @@ To install the SDK as a subchart:
     replicated   1/1     1            1           35s
     ```
 
-## Install the SDK Alongside a Standard Manifest-Based Application
+## Install the SDK Alongside a Kubernetes Manifest-Based Application
 
-For applications that use standard Kubernetes manifest files, the SDK Helm chart can be added to a release and then installed by KOTS alongside the application.
+For applications that use Kubernetes manifest files instead of Helm charts, the SDK Helm chart can be added to a release and then installed by KOTS alongside the application.
 
 <KotsVerReq/>
 
-To add the SDK Helm chart to a release for a standard manifest-based application:
+To add the SDK Helm chart to a release for a Kubernetes manifest-based application:
 
 1. Install the Helm CLI using Homebrew:
 
@@ -99,7 +99,7 @@ To add the SDK Helm chart to a release for a standard manifest-based application
     
     [View a larger version of this image](/images/sdk-kots-release.png)
 
-1. If one was not created automatically, add a Replicated HelmChart custom resource to the release. HelmChart custom resources have `apiVersion: kots.io/v1beta2` and `kind: HelmChart`. 
+1. If one was not created automatically, add a KOTS HelmChart custom resource to the release. HelmChart custom resources have `apiVersion: kots.io/v1beta2` and `kind: HelmChart`. 
 
      **Example:**
   
@@ -126,7 +126,7 @@ To add the SDK Helm chart to a release for a standard manifest-based application
 
 1. Save and promote the release to an internal-only channel used for testing, such as the default Unstable channel.
 
-1. Install the release using a Replicated installer (Emebdded Cluster, KOTS, kURL). For more information, see:
+1. Install the release using a Replicated installer. For more information, see:
      * [Online Installation with Embedded Cluster](/enterprise/installing-embedded)
      * [Online Installation in Existing Clusters with KOTS](/enterprise/installing-existing-cluster)
      * [Online Installation with kURL](/enterprise/installing-kurl)
diff --git a/sidebars.js b/sidebars.js
@@ -508,6 +508,7 @@ const sidebars = {
       'vendor/replicated-sdk-overview',
       'vendor/replicated-sdk-installing',
       'vendor/replicated-sdk-airgap',
+      'vendor/replicated-sdk-development',
       'vendor/replicated-sdk-customizing',
     ],
   },
@@ -605,14 +606,7 @@ const sidebars = {
 
   // DEVELOPER TOOLS
   {type: 'html', value: '<h5>Developer tools</h5>', defaultStyle: true},
-  {
-    type: 'category',
-    label: 'Replicated SDK API (Beta)',
-    items: [
-      'reference/replicated-sdk-apis',
-      'vendor/replicated-sdk-development',
-    ],
-  },
+  'reference/replicated-sdk-apis',
   {
     type: 'category',
     label: 'Replicated CLI',

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		-To install the SDK with KOTS, KOTS v1.104.0 or later and the SDK version 1.0.0-beta.12 or later are required. You can verify the version of KOTS installed with `kubectl kots version`.
	`1`	+To install the SDK with a Replicated installer, KOTS v1.104.0 or later and the SDK version 1.0.0-beta.12 or later are required. You can verify the version of KOTS installed with `kubectl kots version`. For Replicated Embedded Cluster installations, you can see the version of KOTS that is installed by your version of Embedded Cluster in the [Embedded Cluster Release Notes](/release-notes/rn-embedded-cluster).