docs: update sandbox external access for SDK auto URL resolution#400
Closed
jackowfish wants to merge 2 commits into
Closed
docs: update sandbox external access for SDK auto URL resolution#400jackowfish wants to merge 2 commits into
jackowfish wants to merge 2 commits into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
Author
|
Closing - re-doing the SDK setup flow so project + cluster resolve server-side from the API key; docs will follow the new approach. |
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
1 participant
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.
Description
The SDKs now build the external Porter API URL themselves from
PORTER_PROJECT_IDandPORTER_CLUSTER_ID(porter-dev/porter-python-sdk#2, porter-dev/porter-typescript-sdk#2), so users no longer need to hand-assemblePORTER_SANDBOX_BASE_URL. This updates the outside-the-cluster docs from #399 to lead with the three simple env vars and demotesPORTER_SANDBOX_BASE_URLto an escape hatch for targeting a specific URL.Depends on the next sandbox-sdk release going out; until then the published SDKs still need the explicit base URL.