docs: info on getting and running enterprise edge #1303
Conversation
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
There was a problem hiding this comment.
Pull request overview
This PR introduces documentation for Enterprise Edge, the commercial build of Unleash Edge, providing essential information about licensing, deployment, and enterprise-specific features that were previously undocumented.
Key Changes
- Added comprehensive Enterprise Edge documentation covering licensing requirements, installation, persistence options, and enterprise-only features
- Updated README to reference the new Enterprise Edge documentation
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/enterprise-edge.md | New documentation file providing complete guide for Enterprise Edge including licensing requirements, Docker Hub installation instructions, persistence configuration (Redis/S3), quickstart example, and descriptions of enterprise-only features like streaming and observability |
| README.md | Added reference link to Enterprise Edge documentation in the overview section to guide enterprise users to appropriate documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
melindafekete
left a comment
melindafekete
left a comment
There was a problem hiding this comment.
Looks great, thanks @sighphyre
Co-authored-by: Melinda Fekete <[email protected]>
Co-authored-by: Melinda Fekete <[email protected]>
Co-authored-by: Melinda Fekete <[email protected]>
Co-authored-by: Melinda Fekete <[email protected]>
Co-authored-by: Melinda Fekete <[email protected]>
Co-authored-by: Melinda Fekete <[email protected]>
Co-authored-by: Melinda Fekete <[email protected]>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| - **Streaming:** Maintains a streaming connection to the upstream Unleash instance instead of polling. Enable with `--streaming` or `STREAMING=true`. When using a streaming-capable SDK, Edge can also stream updates to SDK clients. Streaming is in early access; consult your Unleash Enterprise contact for compatibility notes. | ||
|
|
||
| - **Edge observability:** Enterprise Edge reports heartbeat and instance state to Unleash Enterprise. This data is displayed in the Unleash Admin UI to assist with monitoring replica health, token usage, and deployment status. |
There was a problem hiding this comment.
I don't think it helps with token usage though. But it helps with other things, like resource usage, latency metrics, network graph visualization, versions, etc.
|
|
||
| If no persistence backend is configured, Enterprise Edge relies solely on in-memory state. In this configuration, any restart requires direct contact with the upstream Unleash instance to revalidate licenses and tokens before Edge can begin serving traffic. | ||
|
|
||
| If you need a persistence option not listed here, contact support. |
There was a problem hiding this comment.
Is any of this (Persistence and cold-start reliability) different from OSS Edge that it's worth mentioning here? Or is this file supposed to become the new reference for Edge docs over time, so we want it to be more encompassing?
There was a problem hiding this comment.
Nice!
Might be worth mentioning that you should update to Unleash Enterprise >= 7.3.0 for Enterprise Edge. (Technically it seems like it may also work for >= 7.2.3, but I'm not entirely sure if that implementation covers all edge cases)
I think it would be cool to highlight that upgrading to Enterprise Edge is a smooth process, in most cases you just need to reach out to us (and update the docker image if you're self-hosted).
Is it worth mentioning something about how daisy chaining works for Enterprise Edge? And how Enterprise Edge will act depending on different license / unreachable states?
Co-authored-by: Nuno Góis <[email protected]>
Co-authored-by: Nuno Góis <[email protected]>
Co-authored-by: Nuno Góis <[email protected]>
Co-authored-by: Nuno Góis <[email protected]>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```shell | ||
| docker run -it \ | ||
| -p 3063:3063 \ | ||
| -e UPSTREAM_URL=<https://your-unleash-instance.com> \ |
There was a problem hiding this comment.
The URL format is incorrect. Remove the angle brackets <> from the URL itself. It should be -e UPSTREAM_URL=https://your-unleash-instance.com (keeping the placeholder but removing the angle brackets around the URL protocol and domain).
| -e UPSTREAM_URL=<https://your-unleash-instance.com> \ | |
| -e UPSTREAM_URL=https://your-unleash-instance.com \ |
4 participants
Scratch together some docs for Enterprise Edge. Kinda just need something rather than nothing right now. I think we'll want to restructure all the Edge docs when we move to the new docs 🎆