feat(sdk): Add support for in-memory Lambda/ephemeral environments #1
Conversation
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
This change introduces new functions to the Go SDK specifically designed for use in ephemeral environments like AWS Lambda, where filesystem access is restricted or undesirable. Previously, using the `zrok` Go SDK required an "enabled" environment on disk (`~/.zrok`), which was created by the `zrok enable` command. This made it difficult to use the SDK from serverless functions. The new functions, `sdk.Enable` and `sdk.Dial`, allow a Go application to: 1. Programmatically enable a `zrok` environment by calling the controller API and holding the resulting Ziti identity entirely in memory. 2. Use this in-memory identity to dial a `zrok` share and receive a standard `net.Conn` object for communication. This eliminates the need for a pre-configured `zrok` environment on disk or a separate proxy process, allowing Lambda functions to act as native `zrok` clients. A corresponding `sdk.Unaccess` function is provided for cleanup, and a new example `sdk/golang/examples/lambda/main.go` demonstrates the complete lifecycle of this new feature.
This change introduces new functions to the Go SDK specifically designed for use in ephemeral environments like AWS Lambda, where filesystem access is restricted or undesirable. Previously, using the `zrok` Go SDK required an "enabled" environment on disk (`~/.zrok`), which was created by the `zrok enable` command. This made it difficult to use the SDK from serverless functions. The new functions, `sdk.Enable` and `sdk.Dial`, allow a Go application to: 1. Programmatically enable a `zrok` environment by calling the controller API and holding the resulting Ziti identity entirely in memory. 2. Use this in-memory identity to dial a `zrok` share and receive a standard `net.Conn` object for communication. This eliminates the need for a pre-configured `zrok` environment on disk or a separate proxy process, allowing Lambda functions to act as native `zrok` clients. A corresponding `sdk.Unaccess` function is provided for cleanup. This change also includes: - A generic example in `sdk/golang/examples/lambda/main.go`. - A specific test demonstrating how to integrate with the `go-mssqldb` driver for SQL Server connections in `sdk/golang/examples/lambda/mssql_test.go`.
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 change introduces new functions to the Go SDK specifically designed for use in ephemeral environments like AWS Lambda, where filesystem access is restricted or undesirable.
Previously, using the
zrokGo SDK required an "enabled" environment on disk (~/.zrok), which was created by thezrok enablecommand. This made it difficult to use the SDK from serverless functions.The new functions,
sdk.Enableandsdk.Dial, allow a Go application to:zrokenvironment by calling the controller API and holding the resulting Ziti identity entirely in memory.zrokshare and receive a standardnet.Connobject for communication.This eliminates the need for a pre-configured
zrokenvironment on disk or a separate proxy process, allowing Lambda functions to act as nativezrokclients.A corresponding
sdk.Unaccessfunction is provided for cleanup, and a new examplesdk/golang/examples/lambda/main.godemonstrates the complete lifecycle of this new feature.