mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-28 00:06:53 +01:00
8916de76be
## What This PR removes or updates references in the docs to Heroku. Most of the code samples have been replaced with a more generic `unleash.example.com` url, while other references have been removed or updated. Also removes old OpenAPI files that are out of date and redundant with the new generation. ## Background Come November and Heroku will no longer offer free deployments of Unleash, so it's about time we remove that claim. Links to the heroku instance are also outdated because we don't have that instance running anymore. Finally, the OpenAPI files we do have there are old and static, so they don't match the current reality. ## Commits * Meta: update ignore file to ignore autogenerated docs I must've missed the ignore file when looking for patterns. * docs: delete old openapi file. This seems to have been a holdover from 2020 and is probably hand-written. It has been superseded by the new autogenerated OpenAPI docs. * docs: add notes for heroku changes to the frontend readme and pkg * docs: remove old openapi article and add redirects to new openapi * docs: fix link in overview doc: point to GitHub instead of heroku * docs: update quickstart docs with new heroku details * docs: remove reference to crashing heroku instance * docs: remove references to herokuapp in code samples * docs: add a placeholder comment * docs: update references for heroku updates * docs: keep using unleash4 for enterprise * docs: remove start:heroku script in favor of start:sandbox * docs: remove 'deploy on heroku button' Now that it's not free anymore (or won't be very shortly), let's remove it. * docs: remove extra newline
31 lines
2.9 KiB
Markdown
31 lines
2.9 KiB
Markdown
---
|
|
title: Unleash introductory overview
|
|
---
|
|
|
|
One of the most important aspects of the architecture to understand is that feature toggles _are evaluated in a client SDKs_ which runs as part of your application. This makes toggle evaluations super-fast (_we're talking nano-seconds_), scalable and resilient against network disturbances. In order to achieve this Unleash compromises a small update-delay when you change your toggle configurations until it is fully propagated to your application (in terms of seconds and is configurable).
|
|
|
|
If you want more details you can read about [our unique architecture](https://www.getunleash.io/blog/our-unique-architecture).
|
|
|
|
### Unleash Server {#unleash-server}
|
|
|
|
Before you can connect your application to Unleash you need a Unleash server. You have a few options available:
|
|
|
|
1. **Unleash Open-source**
|
|
- [Docker](../deploy/getting-started.md)
|
|
- [Helm Chart](https://github.com/unleash/helm-charts/)
|
|
- [GitLab](https://docs.gitlab.com/ee/operations/feature_flags.html#choose-a-client-library)
|
|
2. **Unleash Enterprise**
|
|
- [Hosted Plans](https://www.getunleash.io/plans)
|
|
- [Self-hosted](https://www.getunleash.io/blog/self-host-your-feature-toggle-system)
|
|
|
|
### System Overview {#system-overview}
|
|
|
|
|
|
|
|
- [**The Unleash API**](../api/index.md) - The Unleash instance. This is where you create feature toggles, configure activation strategies, and parameters, etc. The service holding all feature toggles and their configurations. Configurations declare which activation strategies to use and which parameters they should get.
|
|
- **The Unleash admin UI** - The bundled web interface for interacting with the Unleash instance. Manage toggles, define strategies, look at metrics, and much more. Use the UI to [create feature toggles](user_guide/create-feature-toggle.md), [manage project access roles](../how-to/how-to-create-and-assign-custom-project-roles.md), [create API tokens](token.mdx), and more.
|
|
- [**Unleash SDKs**](sdks/index.md) - Unleash SDKs integrate into your applications and get feature configurations from the Unleash API. Use them to check whether features are enabled or disabled and to send metrics to the Unleash API. [See all our SDKs](sdks/index.md)
|
|
- [**The Unleash proxy**](sdks/unleash-proxy.md) - The Unleash proxy sits between front-end and native applications and the Unleash API. You can scale it independently of the Unleash API to handle large request rates without causing issues for the Unleash API.
|
|
|
|
To be super fast (_we're talking nano-seconds_), the [client SDK](sdks/index.md) caches all feature toggles and their current configuration in memory. The activation strategies are also implemented in the SDK. This makes it really fast to check if a toggle is on or off because it is just a simple function operating on local state, without the need to poll data from the database.
|