Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Code Issues Projects Releases Wiki Activity
a8fefe6331
unleash.unleash/website/docs/understanding-unleash/proxy-hosting.mdx

181 lines
10 KiB
Plaintext
Raw Normal View History

docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
---
Docs fixes (#7845)
2024-10-01 11:33:50 +02:00
title: Edge and Proxy hosting strategies
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
---
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
import VideoContent from '@site/src/components/VideoContent.jsx'
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
This document describes the main ways of hosting [Unleash Edge](../generated/unleash-edge.md) (or alternatively [Unleash Proxy](../generated/unleash-proxy.md)) alongside the Unleash API and the tradeoffs between self-hosting compared to using the Frontend API that Unleash hosts for you.
Whether you're hosting Unleash yourself or have a managed solution will be a key consideration.
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
:::info Warning
Edge is the next-gen replacement of the Unleash proxy and is recommended to be used over the proxy in most cases, with the exception of the scenario where custom strategies are being used as Edge does not support these.
:::
docs: make videos bigger (#4980) This PR changes the `VideoContent` component to: - remove the extra text; keeps only videos - makes videos take up the full article width - multiple videos stack vertically (this may or may not be the best way to handle it, but we don't have any instances of using multiple videos as of right now, so we shouldn't touch this until we do). By chance, it also removes a lot of trailing whitespace in files. I suggest checking out the diff with whitespace hidden. Before (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/e47e8827-93e9-4dbc-bdfb-cdb1665fae98) Before (if there were multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/f41ab11f-649f-4369-96fe-70a5d66ced40) After (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/0df9d3fd-3935-4567-93d0-470682fe4bb3) After (if there are multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/98b4a590-c03c-40a1-880f-93ad05090c5e)
2023-10-10 11:42:25 +02:00
<VideoContent videoUrls={["https://www.youtube.com/embed/6uIdF-yByWs"]}/>
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
## Unleash-hosted Frontend API vs self-hosted Edge/Proxy {#unleash-hosted-or-self-hosted}
Which way is right for you will depend on your setup and your needs.
docs: proxy-hosting link to what frontend api is (#5602) Adding links to definition of what frontend api is. Can be confusing for new users to read without seing what it is. --------- Co-authored-by: Thomas Heartman <thomas@getunleash.io>
2023-12-12 12:35:09 +01:00
In general, we recommend you use Edge over the [Frontend API](https://docs.getunleash.io/reference/front-end-api), but we do recognize that self-hosting requires some extra work on your part and that not all our customers need it.
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
docs: Update proxy hosting to point to Frontend API (#4191) ### What We had a customer wonder why `/api/proxy/development` wasn't configured for them. After some digging it was found that they'd followed our documentation and assumed that the proxy was configured for them. However, since we no longer host proxies, this was not the case. This PR updates the documentation to point out that "Unleash hosts everything" now means that our clients should use Frontend API keys and the `/api/frontend` endpoint to get what they used to get from embedded proxies. ## Missing We should make a new illustration in the same vein as the other illustrations on this page to demonstrate what the Frontend API really is. This PR removes the reference to the picture of the topology of having Unleash hosting proxies. --------- Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-07-11 10:55:54 +02:00
If you want Unleash to host the Frontend API for you, you should be aware of the following limitations:
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
Introduce availability page in the docs (#8644)
2024-11-06 12:43:03 +01:00
- This is only available to [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) customers who have signed up for a managed Unleash instance.
docs: Update proxy hosting to point to Frontend API (#4191) ### What We had a customer wonder why `/api/proxy/development` wasn't configured for them. After some digging it was found that they'd followed our documentation and assumed that the proxy was configured for them. However, since we no longer host proxies, this was not the case. This PR updates the documentation to point out that "Unleash hosts everything" now means that our clients should use Frontend API keys and the `/api/frontend` endpoint to get what they used to get from embedded proxies. ## Missing We should make a new illustration in the same vein as the other illustrations on this page to demonstrate what the Frontend API really is. This PR removes the reference to the picture of the topology of having Unleash hosting proxies. --------- Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-07-11 10:55:54 +02:00
- We allow short spikes in traffic and our adaptive infrastructure will automatically scale to your needs.
- Please check the [Fair Use Policy](https://www.getunleash.io/fair-use-policy) to see the limits of the Unleash-hosted Frontend API.
docs: Clarify edge proximity to users (#5601) A benefit of hosting your own edge instance is that it will be as close to end users as you are. --------- Co-authored-by: Thomas Heartman <thomas@getunleash.io>
2023-12-12 12:35:57 +01:00
- There's no guarantee that it'll be geographically close to your end users, this means your end users might be getting slower response times on feature flag evaluations.
Docs fixes (#7845)
2024-10-01 11:33:50 +02:00
- When we host the frontend API, we will also receive whatever end-user data you put in the [Unleash context](../reference/unleash-context.md). This may or may not be an issue depending on your business requirements.
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
Docs fixes (#7845)
2024-10-01 11:33:50 +02:00
Hosting Edge requires a little more setup than the Unleash-hosted Frontend API does, but it offers a number of benefits over both the frontend API and Proxy:
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
- You can scale Edge instances horizontally and automatically.
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
- There's no request cap or extra charges.
Docs fixes (#7845)
2024-10-01 11:33:50 +02:00
- Edge can handle multiple sets of API tokens and sync these automatically. Compared to the legacy proxy, it is not necessary to set up single instances per token.
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
- A key benefit of Edge is its ability to dynamically update new tokens while running. This greatly simplifies scaling up additional application workloads that leverage new tokens without the need to restart the instance or make large changes to infra, as was the prior requirement with the proxy.
- You can arrange for Edge to be close to your applications, minimizing response times.
- You have full control of all your user data. None of the data that Edge receives is ever sent to the Unleash API. This keeps _your_ data in _your_ hands.
docs: make videos bigger (#4980) This PR changes the `VideoContent` component to: - remove the extra text; keeps only videos - makes videos take up the full article width - multiple videos stack vertically (this may or may not be the best way to handle it, but we don't have any instances of using multiple videos as of right now, so we shouldn't touch this until we do). By chance, it also removes a lot of trailing whitespace in files. I suggest checking out the diff with whitespace hidden. Before (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/e47e8827-93e9-4dbc-bdfb-cdb1665fae98) Before (if there were multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/f41ab11f-649f-4369-96fe-70a5d66ced40) After (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/0df9d3fd-3935-4567-93d0-470682fe4bb3) After (if there are multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/98b4a590-c03c-40a1-880f-93ad05090c5e)
2023-10-10 11:42:25 +02:00
- You can easily add more Edge instances in different regions, as described in the [multi-region](#multi-region) section.
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
## Unleash hosts everything
Align availability information in the docs (#8177)
2024-10-03 10:33:22 +02:00
:::note Availability
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
Introduce availability page in the docs (#8644)
2024-11-06 12:43:03 +01:00
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
docs: make videos bigger (#4980) This PR changes the `VideoContent` component to: - remove the extra text; keeps only videos - makes videos take up the full article width - multiple videos stack vertically (this may or may not be the best way to handle it, but we don't have any instances of using multiple videos as of right now, so we shouldn't touch this until we do). By chance, it also removes a lot of trailing whitespace in files. I suggest checking out the diff with whitespace hidden. Before (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/e47e8827-93e9-4dbc-bdfb-cdb1665fae98) Before (if there were multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/f41ab11f-649f-4369-96fe-70a5d66ced40) After (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/0df9d3fd-3935-4567-93d0-470682fe4bb3) After (if there are multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/98b4a590-c03c-40a1-880f-93ad05090c5e)
2023-10-10 11:42:25 +02:00
:::
Introduce availability page in the docs (#8644)
2024-11-06 12:43:03 +01:00
Unleash no longer hosts instances of the proxy, but makes the [Frontend API](../reference/front-end-api) available to all [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) customers. The API is backed by an Amazon RDS database. Your applications can connect to the frontend API from your own cloud or from other hosting solutions.
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
Docs fixes (#7845)
2024-10-01 11:33:50 +02:00
In order to access the frontend API you'll need:
- A [Frontend API key](../reference/api-tokens-and-client-keys#front-end-tokens) for the environment you'd like to use.
- The Frontend API URL. This will be your Unleash instance's URL followed by `/api/frontend`.
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
docs: Update proxy hosting to point to Frontend API (#4191) ### What We had a customer wonder why `/api/proxy/development` wasn't configured for them. After some digging it was found that they'd followed our documentation and assumed that the proxy was configured for them. However, since we no longer host proxies, this was not the case. This PR updates the documentation to point out that "Unleash hosts everything" now means that our clients should use Frontend API keys and the `/api/frontend` endpoint to get what they used to get from embedded proxies. ## Missing We should make a new illustration in the same vein as the other illustrations on this page to demonstrate what the Frontend API really is. This PR removes the reference to the picture of the topology of having Unleash hosting proxies. --------- Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-07-11 10:55:54 +02:00
This is the simplest, but also most limited (by far) way to use Unleash client SDKs. In this setup, Unleash hosts both the Unleash API and the Unleash frontend API. With Unleash hosting, you'll only need to worry about the Frontend API keys and the URL to access the endpoint.
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
docs: make videos bigger (#4980) This PR changes the `VideoContent` component to: - remove the extra text; keeps only videos - makes videos take up the full article width - multiple videos stack vertically (this may or may not be the best way to handle it, but we don't have any instances of using multiple videos as of right now, so we shouldn't touch this until we do). By chance, it also removes a lot of trailing whitespace in files. I suggest checking out the diff with whitespace hidden. Before (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/e47e8827-93e9-4dbc-bdfb-cdb1665fae98) Before (if there were multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/f41ab11f-649f-4369-96fe-70a5d66ced40) After (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/0df9d3fd-3935-4567-93d0-470682fe4bb3) After (if there are multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/98b4a590-c03c-40a1-880f-93ad05090c5e)
2023-10-10 11:42:25 +02:00
While this is easy to get started with, it comes with the limitations described in the [section on tradeoffs between self-hosted and Unleash-hosted setups](#unleash-hosted-or-self-hosted).
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
docs: Update proxy hosting to point to Frontend API (#4191) ### What We had a customer wonder why `/api/proxy/development` wasn't configured for them. After some digging it was found that they'd followed our documentation and assumed that the proxy was configured for them. However, since we no longer host proxies, this was not the case. This PR updates the documentation to point out that "Unleash hosts everything" now means that our clients should use Frontend API keys and the `/api/frontend` endpoint to get what they used to get from embedded proxies. ## Missing We should make a new illustration in the same vein as the other illustrations on this page to demonstrate what the Frontend API really is. This PR removes the reference to the picture of the topology of having Unleash hosting proxies. --------- Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-07-11 10:55:54 +02:00
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
## Unleash hosts the API, you host Edge
docs: Update proxy hosting to point to Frontend API (#4191) ### What We had a customer wonder why `/api/proxy/development` wasn't configured for them. After some digging it was found that they'd followed our documentation and assumed that the proxy was configured for them. However, since we no longer host proxies, this was not the case. This PR updates the documentation to point out that "Unleash hosts everything" now means that our clients should use Frontend API keys and the `/api/frontend` endpoint to get what they used to get from embedded proxies. ## Missing We should make a new illustration in the same vein as the other illustrations on this page to demonstrate what the Frontend API really is. This PR removes the reference to the picture of the topology of having Unleash hosting proxies. --------- Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-07-11 10:55:54 +02:00
Align availability information in the docs (#8177)
2024-10-03 10:33:22 +02:00
:::note Availability
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
Introduce availability page in the docs (#8644)
2024-11-06 12:43:03 +01:00
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
:::
Align availability information in the docs (#8177)
2024-10-03 10:33:22 +02:00
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
![An architecture diagram of using Edge in a setup where Unleash hosts the API and you host the proxy.](/img/proxy-hosting-unleash-api-customer-proxy-edge.svg)
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
Docs fixes (#7845)
2024-10-01 11:33:50 +02:00
You host Edge yourself. It runs in a standalone container alongside your other applications in your cloud or hosting setup. Unleash manages the Unleash API, the admin UI, and the backing database in our AWS setup; the API and the UI run together in a Kubernetes deployment and connect to an Amazon RDS database.
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
docs: make videos bigger (#4980) This PR changes the `VideoContent` component to: - remove the extra text; keeps only videos - makes videos take up the full article width - multiple videos stack vertically (this may or may not be the best way to handle it, but we don't have any instances of using multiple videos as of right now, so we shouldn't touch this until we do). By chance, it also removes a lot of trailing whitespace in files. I suggest checking out the diff with whitespace hidden. Before (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/e47e8827-93e9-4dbc-bdfb-cdb1665fae98) Before (if there were multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/f41ab11f-649f-4369-96fe-70a5d66ced40) After (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/0df9d3fd-3935-4567-93d0-470682fe4bb3) After (if there are multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/98b4a590-c03c-40a1-880f-93ad05090c5e)
2023-10-10 11:42:25 +02:00
You'll need to configure Edge and the SDKs.
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
### On Unleash
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
Docs fixes (#7845)
2024-10-01 11:33:50 +02:00
- Create one or more [client API tokens](https://docs.getunleash.io/reference/api-tokens-and-client-keys#client-tokens) scoped to the projects/environments you wish to use the Edge instance for. Refer to [how to create API tokens](https://docs.getunleash.io/how-to/how-to-create-api-tokens) for the steps to create one.
- Create frontend tokens for the frontend apps that will retrieve feature flags from Edge.
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
### On Edge
chore: rename toggle to flag docs #1 (#7136) This is first iteration for docs.
2024-05-24 11:30:10 +02:00
Edge will fetch feature flags from the specified upstream Unleash instance for every client API key it has been made aware of, either during startup (recommended) or separate endpoint requests. It will then periodically sync features with upstream.
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
Docs fixes (#7845)
2024-10-01 11:33:50 +02:00
It will then accept frontend or backend tokens from application SDKs.
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
docs: make videos bigger (#4980) This PR changes the `VideoContent` component to: - remove the extra text; keeps only videos - makes videos take up the full article width - multiple videos stack vertically (this may or may not be the best way to handle it, but we don't have any instances of using multiple videos as of right now, so we shouldn't touch this until we do). By chance, it also removes a lot of trailing whitespace in files. I suggest checking out the diff with whitespace hidden. Before (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/e47e8827-93e9-4dbc-bdfb-cdb1665fae98) Before (if there were multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/f41ab11f-649f-4369-96fe-70a5d66ced40) After (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/0df9d3fd-3935-4567-93d0-470682fe4bb3) After (if there are multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/98b4a590-c03c-40a1-880f-93ad05090c5e)
2023-10-10 11:42:25 +02:00
:::info Warning
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
Docs fixes (#7845)
2024-10-01 11:33:50 +02:00
Make sure to use the correct token type for your use case:
- Frontend API: Use for frontend-facing apps; Edge returns application-specific context.
- Client API: Use for backend SDKs; Edge returns the entire flag payload for the scope of the token (project/environment).
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
:::
Docs fixes (#7845)
2024-10-01 11:33:50 +02:00
#### Start Edge and populate flag cache
This initial command will populate the flag cache on startup using the client token specified in the environment variable:
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
```docker run -p 3063:3063 -e TOKENS='CLIENT_API_TOKEN' -e UPSTREAM_URL='UPSTREAM_URL' unleashorg/unleash-edge:v8.1 edge```
The following can be used to pass new tokens to Edge for different project/environment scopes:
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
```curl --location --request GET 'http://0.0.0.0:3063/api/client/features' \ --header 'Content-Type: application/json' \ --header 'Authorization: NEW_TOKEN' \ --data-raw ''```
### On SDKs
Docs fixes (#7845)
2024-10-01 11:33:50 +02:00
- Point frontend/client SDKs to Edge endpoints:
- **Backend SDKs**: `/api/client`.
- **Frontend SDKs**: `/api/frontend`, `/api/proxy`.
docs: make videos bigger (#4980) This PR changes the `VideoContent` component to: - remove the extra text; keeps only videos - makes videos take up the full article width - multiple videos stack vertically (this may or may not be the best way to handle it, but we don't have any instances of using multiple videos as of right now, so we shouldn't touch this until we do). By chance, it also removes a lot of trailing whitespace in files. I suggest checking out the diff with whitespace hidden. Before (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/e47e8827-93e9-4dbc-bdfb-cdb1665fae98) Before (if there were multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/f41ab11f-649f-4369-96fe-70a5d66ced40) After (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/0df9d3fd-3935-4567-93d0-470682fe4bb3) After (if there are multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/98b4a590-c03c-40a1-880f-93ad05090c5e)
2023-10-10 11:42:25 +02:00
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
## You host everything
Align availability information in the docs (#8177)
2024-10-03 10:33:22 +02:00
:::note Availability
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
Align availability information in the docs (#8177)
2024-10-03 10:33:22 +02:00
**Plan**: [Open Source](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing).
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
:::
Align availability information in the docs (#8177)
2024-10-03 10:33:22 +02:00
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
![An architecture diagram of using the proxy in a single-region, self-hosted setup.](/img/proxy-hosting-customer-single-edge.svg)
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
You host everything yourself. Everything runs where and how you configure it to.
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
**To configure Edge and the SDKs, follow steps in the [previous section on Unleash hosts the API, you host Edge](#unleash-hosts-the-api-you-host-edge)**
Docs fixes (#7845)
2024-10-01 11:33:50 +02:00
As you might expect, doing everything yourself gives you the most flexibility, but also requires the most effort. However, if you're already hosting Unleash yourself, this shouldn't be any more difficult than the previous section.
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
docs: make videos bigger (#4980) This PR changes the `VideoContent` component to: - remove the extra text; keeps only videos - makes videos take up the full article width - multiple videos stack vertically (this may or may not be the best way to handle it, but we don't have any instances of using multiple videos as of right now, so we shouldn't touch this until we do). By chance, it also removes a lot of trailing whitespace in files. I suggest checking out the diff with whitespace hidden. Before (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/e47e8827-93e9-4dbc-bdfb-cdb1665fae98) Before (if there were multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/f41ab11f-649f-4369-96fe-70a5d66ced40) After (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/0df9d3fd-3935-4567-93d0-470682fe4bb3) After (if there are multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/98b4a590-c03c-40a1-880f-93ad05090c5e)
2023-10-10 11:42:25 +02:00
As described in the [section on tradeoffs between self-hosted and Unleash-hosted setups](#unleash-hosted-or-self-hosted), running Edge yourself gives you a number of benefits.
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
## Multi-region
![An architecture diagram of using the proxy in a multi-region, self-hosted setup.](/img/proxy-hosting-customer-multi-edge.svg)
You can also use Edge for a multi-region setup. You can run Edge in a different region to the API and still connect to the API. Because Edge runs closer to your applications it still provides you benefits in terms of quicker response times. Everything should be configured as described in the [you host everything section](#you-host-everything) or the [Unleash hosts the API, you host Edge section](#unleash-hosts-the-api-you-host-edge). You can add as many Edge instances in as many extra regions as you want.
docs: make videos bigger (#4980) This PR changes the `VideoContent` component to: - remove the extra text; keeps only videos - makes videos take up the full article width - multiple videos stack vertically (this may or may not be the best way to handle it, but we don't have any instances of using multiple videos as of right now, so we shouldn't touch this until we do). By chance, it also removes a lot of trailing whitespace in files. I suggest checking out the diff with whitespace hidden. Before (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/e47e8827-93e9-4dbc-bdfb-cdb1665fae98) Before (if there were multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/f41ab11f-649f-4369-96fe-70a5d66ced40) After (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/0df9d3fd-3935-4567-93d0-470682fe4bb3) After (if there are multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/98b4a590-c03c-40a1-880f-93ad05090c5e)
2023-10-10 11:42:25 +02:00
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
## Legacy: Unleash hosts the API, you host the Proxy
:::info Recommendation
docs: make videos bigger (#4980) This PR changes the `VideoContent` component to: - remove the extra text; keeps only videos - makes videos take up the full article width - multiple videos stack vertically (this may or may not be the best way to handle it, but we don't have any instances of using multiple videos as of right now, so we shouldn't touch this until we do). By chance, it also removes a lot of trailing whitespace in files. I suggest checking out the diff with whitespace hidden. Before (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/e47e8827-93e9-4dbc-bdfb-cdb1665fae98) Before (if there were multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/f41ab11f-649f-4369-96fe-70a5d66ced40) After (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/0df9d3fd-3935-4567-93d0-470682fe4bb3) After (if there are multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/98b4a590-c03c-40a1-880f-93ad05090c5e)
2023-10-10 11:42:25 +02:00
This approach is no longer recommended. You should use [Unleash Edge](../reference/unleash-edge) instead of the Unleash proxy.
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
If you are an existing Proxy user, see our [Edge migration guide](https://github.com/Unleash/unleash-edge/blob/main/migration-guide.md) for a guide on how to migrate.
Please take note of the section covering features Edge does not currently support in the same linked document before planning a migration.
:::
Align availability information in the docs (#8177)
2024-10-03 10:33:22 +02:00
:::note Availability
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
Introduce availability page in the docs (#8644)
2024-11-06 12:43:03 +01:00
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing).
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
:::
Align availability information in the docs (#8177)
2024-10-03 10:33:22 +02:00
docs: Edge updates for docs/proxy-hosting (#4275) docs: document edge/proxy hosting options and strategies
2023-08-02 14:32:12 +02:00
![An architecture diagram of using the proxy in a setup where Unleash hosts the API and you host the proxy.](/img/proxy-hosting-unleash-api-customer-proxy.svg)
You host the proxy yourself. It runs in a standalone container alongside your other applications in your cloud or hosting setup. Unleash manages the Unleash API, the admin UI, and the backing database in our AWS setup: the API and the UI run together in a Kubernetes deployment and connect to an Amazon RDS database.
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
You'll need to configure the proxy and the proxy client SDKs.
For the proxy, configure:
Docs fixes (#7845)
2024-10-01 11:33:50 +02:00
- The Unleash API url. This is your Unleash instance URL followed by `/api`.
- A [client API token](../reference/api-tokens-and-client-keys.mdx#client-tokens). Refer to [how to create API tokens](../how-to/how-to-create-api-tokens.mdx) for the steps to create one.
refactor: move docs into new structure / fix links for SEO (#2416) ## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
2022-11-22 10:05:30 +01:00
- One or more [proxy client keys](../reference/api-tokens-and-client-keys.mdx#proxy-client-keys). Refer to the [configuration section of the proxy document](../reference/unleash-proxy#configuration) for more details.
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
For the proxy client SDK, configure:
- One of the proxy client keys that you configured for the proxy.
Docs fixes (#7845)
2024-10-01 11:33:50 +02:00
- The proxy's endpoint. This will depend on where and how you're hosting the proxy, but will typically end in `/proxy`.
docs: add proxy deployment diagrams (#1743) * docs: remove empty table row * docs: add placeholder proxy hosting article * docs: add images, describe first one * docs: describe the customer-hosted proxy solution * docs: describe the self-hosted single-region setup. * docs: describe enterprise multi-region setup. * docs: minor changes * docs: update lists; restructure * docs: more minor changes * docs: add alt text to diagrams * docs: update proxy hosting doc * docs: some prettier formatting * docs: add link to proxy hosting doc * docs: format proxy config table * docs: prettier formatting
2022-06-23 08:28:01 +02:00
docs: make videos bigger (#4980) This PR changes the `VideoContent` component to: - remove the extra text; keeps only videos - makes videos take up the full article width - multiple videos stack vertically (this may or may not be the best way to handle it, but we don't have any instances of using multiple videos as of right now, so we shouldn't touch this until we do). By chance, it also removes a lot of trailing whitespace in files. I suggest checking out the diff with whitespace hidden. Before (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/e47e8827-93e9-4dbc-bdfb-cdb1665fae98) Before (if there were multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/f41ab11f-649f-4369-96fe-70a5d66ced40) After (single video): ![image](https://github.com/Unleash/unleash/assets/17786332/0df9d3fd-3935-4567-93d0-470682fe4bb3) After (if there are multiple videos): ![image](https://github.com/Unleash/unleash/assets/17786332/98b4a590-c03c-40a1-880f-93ad05090c5e)
2023-10-10 11:42:25 +02:00
This setup requires a little more setup on your part than the Unleash-hosted proxy does, but it offers all the benefits described in the [section on tradeoffs between self-hosted and Unleash-hosted setups](#unleash-hosted-or-self-hosted).
Reference in New Issue Copy Permalink