feat: automatic port forwarding for deployed services #1052
Conversation
This file contains 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
thsig
requested changes
Aug 6, 2019
| @@ -241,11 +241,11 @@ export async function syncToService( | |||
| targetName: string, | |||
| log: LogEntry, | |||
| ) { | |||
| const targetDeployment = `${targetKind.toLowerCase()}/${targetName}` | |||
| const targetResource = `${targetKind.toLowerCase()}/${targetName}` | |||
There was a problem hiding this comment.
Remove the block comment above this function (since we're now relying on a general port-forward cache that's used for more than just hot reloading).
| import { isBuiltIn } from "./util" | ||
| import { LogEntry } from "../../logger/log-entry" | ||
|
|
||
| // TODO: implement stopPortForward handler |
There was a problem hiding this comment.
Should we add a brief high-level comment here? Maybe something like:
Maintains a simple in-process cache of randomly allocated local ports that have been port-forwarded to a given port on a given Kubernetes resource. This removes the need for the user to manually establish port-forwards for e.g. services defined in Garden config files.
garden-service/src/types/service.ts
Outdated
| .required() | ||
| .description("The target port on the service."), | ||
| urlProtocol: joi.string() | ||
| .description("The protocol to use for URLs pointing at the port. This can be valid URI protocol."), |
There was a problem hiding this comment.
"This can be" -> "This can be any"
edvald
force-pushed
the
automatic-forwarding
branch
from
2641015 to
7fc64ec
Compare
thsig
approved these changes
Aug 6, 2019
This adds a built-in TCP proxy for long-running Garden processes, that immediately opens a port for each forwardable service port (as specified by providers) and creates a tunnel on-demand when the port is accessed. This should work for any TCP port, and is implemented here for the kubernetes provider, but the proxy itself could be implemented for other providers through the fairly simple `getPortForward` handler interface. Unlike kubefwd, for example, this implementation avoids any need to mess with domain names or host files (and by extension running as root) since a random free port is assigned directly on localhost. The tunnels are only created when a connection is first made, and are then kept alive while the Garden agent is running. Closes #967
thsig
force-pushed
the
automatic-forwarding
branch
from
7fc64ec to
43b414f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This adds a built-in TCP proxy for long-running Garden processes,
that immediately opens a port for each forwardable service port (as
specified by providers) and creates a tunnel on-demand when the port is
accessed.
This should work for any TCP port, and is implemented here for the
kubernetes provider, but the proxy itself could be implemented for other
providers through the fairly simple
getPortForwardhandler interface.Unlike kubefwd, for example, this implementation avoids any
need to mess with domain names or host files (and by extension running
as root) since a random free port is assigned directly on localhost.
The tunnels are only created when a connection is first made, and are
then kept alive while the Garden agent is running.
Closes #967