-
Notifications
You must be signed in to change notification settings - Fork 31
Use port forward to access the SDK API #2875
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,11 +6,30 @@ 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). | ||
|
|
||
| ## Access the SDK API | ||
| ## Use Port Forwarding to Access the SDK API | ||
|
|
||
| The Replicated SDK API is available after the Replicated SDK is installed and initialized in a cluster. For information about installing the SDK, see [Installing with Helm](/vendor/install-with-helm). | ||
| 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. | ||
|
|
||
| After the SDK is installed, the Replicated SDK API service is exposed at `replicated:3000`. To verify where the Replicated SDK API service is exposed, you can run `kubectl get service -A`. | ||
| 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} | ||
| ``` | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Confirmed that these steps worked for me after installing the SDK in integration mode in my cluster |
||
|
|
||
| ## app | ||
|
|
||
|
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.