1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00

docs: improve introduction section

This commit is contained in:
Ivar Conradi Østhus 2021-06-14 21:35:19 +02:00
parent cceb360b3a
commit b6e3903b32
No known key found for this signature in database
GPG Key ID: 31AC596886B0BD09
6 changed files with 1669 additions and 17 deletions

View File

@ -3,7 +3,10 @@ id: strategy_constraints
title: Strategy Constraints
---
> Strategy constraints is part of Unleash Enterprise.
<div class="alert alert--info" role="alert">
Strategy constraints part of Unleash Pro and Enterprise.
</div>
<br />
Strategy constraints allow you to set pre-conditions on activation strategies that needs to be satisfied for the activation strategies to take effect.

View File

@ -5,29 +5,31 @@ slug: /
sidebar_position: 1
---
Welcome to the Unleash documentation. We know that getting to know a new solution might be tedious. Our goal with our documentation is to guide you through the most essential concepts of Unleash.
Welcome to the Unleash documentation. Our goal with our documentation is to guide you through the most essential concepts of Unleash.
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, but of course it compromises a small update-delay when you change your toggle configurations (in terms of seconds and is configurable).
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 talk 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 cam read about [our unique architecture](https://www.unleash-hosted.com/articles/our-unique-architecture).
## Unleash Server {#unleash-server}
### 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 - Self-managed](deploy/getting_started)
2. [Unleash Enterprise - Cloud-hosted](https://www.getunleash.io/plans)
3. [Unleash Enterprise - Self-hosted](https://www.getunleash.io)
1. **Unleash Open-source**
- [Docker](deploy/getting_started)
- [Helm Chart](https://github.com/unleash/helm-charts/)
- [Click-to-deploy on Heroku](https://www.heroku.com/deploy/?template=https://github.com/Unleash/unleash)
2. **Unleash Enterprise**
- [Hosted Plans](https://www.getunleash.io/plans)
- [Self-hosted](https://www.unleash-hosted.com/articles/self-host-your-feature-toggle-system/)
## System Overview {#system-overview}
### System Overview {#system-overview}
Unleash is composed of the following parts:
![system_overview](/img/Unleash_architecture.svg 'System Overview')
- **Unleash API** - The service holding all feature toggles and their configurations. Configurations declare which activation strategies to use and which parameters they should get.
- **Unleash UI** - The dashboard used to manage feature toggles, define new strategies, look at metrics, etc.
- **Unleash SDK** - Used by clients to check if a feature is enabled or disabled. The SDK also collects metrics and sends them to the Unleash API. Activation Strategies are also implemented in the SDK.
- **Unleash API** - The service holding all feature toggles and their configurations. Configurations declare which activation strategies to use and which parameters they should get. [API documentation](/api)
- **Unleash Admin UI** - The dashboard used to manage feature toggles, define new strategies, look at metrics, etc. [Create your first feature toggle](./user_guide/create_feature_toggle)
- **Unleash SDK** - Used by clients to check if a feature is enabled or disabled. The SDK also collects metrics and sends them to the Unleash API. [See all our SDKs](/sdks)
- **Unleash Proxy** - Sits between frontend/native applications and the Unleash API. Ensures high performance and that you don't expose the full feature toggle configuration to end-users. [Read more about Unleash Proxy](/sdks/unleash-proxy)
![system_overview](/img/unleash-diagram.png 'System Overview')
To be super fast (_we talk nano-seconds_), the [client SDK](/sdks/index) 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.

View File

@ -3,7 +3,9 @@ id: projects
title: Projects
---
> Project support is available as part of Unleash Enterprise.
<div class="alert alert--info" role="alert">
Strategy constraints part of Unleash Pro and Enterprise.
</div>
## Overview {#overview}

View File

@ -14,11 +14,16 @@
--ifm-color-primary-light: #3f5b64;
--ifm-color-primary-lighter: #425f69;
--ifm-color-primary-lightest: #4a6c76;
--ifm-code-font-size: 95%;
--ifm-font-size-base: 16px;
--ifm-code-font-size: 90%;
--ifm-font-size-base: 15px;
--ifm-link-color: #817afe;
--navbar-link-color: #122d33;
}
[class^='docTitle'] {
font-size: 2.5rem !important;
}
.docusaurus-highlight-code-line {
background-color: rgb(72, 77, 91);
display: block;

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 123 KiB