1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-05-08 01:15:49 +02:00

Docs for release management (#9555)

This commit is contained in:
Melinda Fekete 2025-03-28 10:42:39 +01:00 committed by GitHub
parent 8793d9e632
commit 2d3d6aa38a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 120 additions and 4 deletions

View File

@ -16,7 +16,11 @@ This is an example of a feature that is only available to Enterprise customers w
- [Open Source](https://www.getunleash.io/pricing) - Available on [GitHub](https://github.com/Unleash/unleash) under an Apache 2.0 license.
- Pro - Currently not offered.
- [Enterprise](https://www.getunleash.io/pricing) - Available as Pay-as-you-go or as an annual contract.
- [Enterprise](https://www.getunleash.io/pricing) - Available as Pay-as-you-go or as an annual contract, as cloud-hosted or self-hosted.
## Beta features
Some new Unleash features are tagged as `BETA` in the documentation. This means that the feature may be subject to change or discontinuation. Unleash may decide to enable such features for a select number of customers only. If you're interested in trying out a beta feature, please reach out to Customer Success at beta@getunleash.io.
## Versioning

View File

@ -24,7 +24,7 @@ There are several steps to ensuring your feature flag implementation is audit-pr
Unleash is designed to support critical enterprise compliance standards. In this tutorial, we reference three frameworks that organizations in highly regulated industries are most likely to be audited against:
[FedRAMP](/using-unleash/compliance/fedramp): A U.S. government program that standardizes how federal agencies assess, authorize, and monitor cloud services. For organizations listing their software on the [FedRAMP](https://www.fedramp.gov/program-basics/) marketplace, Unleash's security controls are designed to meet these rigorous requirements.
[FedRAMP](/using-unleash/compliance/fedramp): A U.S. government program that standardizes how federal agencies assess, authorize, and monitor cloud services. For organizations listing their software on the [FedRAMP](https://www.fedramp.gov) marketplace, Unleash's security controls are designed to meet these rigorous requirements.
[SOC 2 Type II](/using-unleash/compliance/soc2): A cybersecurity framework that assesses how organizations protect customer data. Our architecture provides the necessary controls and audit trails to meet stringent SOC 2 requirements, ensuring your feature flag management processes are transparent, secure, and verifiable.

View File

@ -109,6 +109,14 @@ You can assign the following root permissions:
|-----------------|--------------------------------|
| Create projects | Create [projects](./projects). |
#### Release template permissions
| Permission Name | Description |
|-----------------|---------------------------|
| Create release plan template | Create [release template](./release-templates). |
| Update release plan template | Update [release template](./release-templates). |
| Delete release plan template | Delete [release template](./release-templates). |
#### Role permissions
| Permission Name | Description |

View File

@ -0,0 +1,103 @@
---
title: Release templates
---
:::note Availability
**Plan**: [Enterprise](https://www.getunleash.io/pricing) cloud-hosted | **Version**: `6.8+` in [BETA](/availability#beta-features).
:::
<details>
<summary>Participate in the beta program</summary>
Release templates are currently in beta. If you're interesting in trying the feature out, please contact us at beta@getunleash.io.
Future iterations of the feature may include:
- An overview of ongoing releases and currently running milestones across all projects
- Automated transitions between different milestones
- Reporting on release templates
</details>
## Overview
[Release templates](#release-template) help you standardize your approach to rolling out new features. By predefining a set of release milestones, you can ensure consistency across all your feature rollouts.
Instead of manually configuring the same [activation strategies](/reference/activation-strategies) across different feature flags, you can define release templates once and apply them to any feature flag to initiate a rollout.
[Milestones](#milestone) rely on activation strategies to give you full flexibility when it comes to customizing your release templates. Each milestone executes sequentially, ensuring a structured release process.
For example, you might define 3 milestones for a release:
- **Milestone 1**: Enable the feature for internal teams to test functionality and resolve initial issues.
- **Milestone 2**: Expand the rollout to 20% of beta users to gather feedback and monitor performance.
- **Milestone 3**: Release the feature to all users after confirming stability and addressing earlier feedback.
#### Release template
A predefined sequence of [milestones](#milestone) that structures a feature release.
#### Milestone
Sequential stages within a [release template](#release-template). Each milestone must contain at least one [activation strategy](/reference/activation-strategies), which determines when a feature flag is enabled.
You can combine multiple activation strategies in a single milestone. Unleash evaluates each strategy independently, enabling the flag if any strategy resolves to true.
#### Release plan
An instance of a [release template](#release-template) applied to a specific feature flag in a specific environment. You can combine a release plan with additional activation strategies.
## Create a release template
> Note: For this action, you must be an Editor or have a custom root role with [release templates permissions](/reference/rbac#release-template-permissions).
To create a release template, do the following:
1. In the Admin UI, go to **Configure > Release templates**, and click **New template**.
2. Enter the template name and an optional description.
3. For the first milestone, click **Add strategy**.
4. Choose a strategy type and configure your [strategy](/reference/activation-strategies).
5. Click **Add strategy**.
6. Optional: Add, rename, or reorder milestones as needed.
7. Click **Create template**.
## Configure a gradual rollout with release templates
Milestones are designed to be flexible and do not inherit the configurations of previous milestones. To build a gradual rollout where each milestone expands on the previous one, you must manually configure the progression of the strategies and their constraints.
For example, suppose you want to structure your rollout as follows:
- **Milestone 1**: Enable the feature for 50% of users on the _Basic_ plan.
- **Milestone 2**: Keep the same 50% of _Basic_ users from Milestone 1 and add 25% of _Premium_ users.
To achieve this, you need to:
1. Create Milestone 1 with a strategy to target the 50% of _Basic_ plan users.
2. Create Milestone 2 and keep the '50% _Basic_ plan' strategy. Add a new strategy to target 25% _Premium_ plan users.
The configuration would look something like this:
![Example of progressive milestones](/img/progressive-milestones.png)
## Apply a release template to a feature flag
To apply a release template to a feature flag, do the following:
1. In the Admin UI, open a feature flag and select your target environment.
2. Click **Use template** and select one of the available release templates.
3. Click **Add release plan**.
If the environment is enabled, the first milestone starts automatically.
## Perform a release using a release plan
Release plans apply per feature and environment. To add a release plan, [apply a release template](#apply-a-release-template-to-a-feature-flag).
### Start the release
If the environment is enabled, the first milestone begins automatically upon adding the release plan. Otherwise, enable the environment to start the first milestone.
### Pause the release
Pause the release at any time by disabling the environment for the feature flag.
### Progress to the next milestone
To progress to the next milestone, click **Start** on the milestone you want to run.
### Revert to a previous milestone
To return to a previous stage of the rollout, click **Restart** on the milestone you want to revert to.

View File

@ -7,7 +7,7 @@ description: 'Secure and compliant feature flags at scale with Unleash.'
## Overview
Unleash is designed to help organizations meet strict compliance requirements, supporting frameworks like [FedRAMP](https://www.fedramp.gov/program-basics/), [SOC 2](https://www.aicpa-cima.com/topic/audit-assurance/audit-and-assurance-greater-than-soc-2), [ISO 27001](https://en.wikipedia.org/wiki/ISO/IEC_27001), and more. Features such as [audit logs](/reference/events#event-log), [role-based access control](/reference/rbac) (RBAC), and [change request](/reference/change-requests) workflows enable secure feature management at scale.
Unleash is designed to help organizations meet strict compliance requirements, supporting frameworks like [FedRAMP](https://www.fedramp.gov), [SOC 2](https://www.aicpa-cima.com/topic/audit-assurance/audit-and-assurance-greater-than-soc-2), [ISO 27001](https://en.wikipedia.org/wiki/ISO/IEC_27001), and more. Features such as [audit logs](/reference/events#event-log), [role-based access control](/reference/rbac) (RBAC), and [change request](/reference/change-requests) workflows enable secure feature management at scale.
For a detailed overview of how [Unleash Enterprise](https://www.getunleash.io/pricing) can help you with your compliance requirements, refer to our guides:
- [FedRAMP](/using-unleash/compliance/fedramp)

View File

@ -7,7 +7,7 @@ description: 'FedRAMP compliant feature flags at scale with Unleash.'
## Overview
When operating in a [FedRAMP-compliant](https://www.fedramp.gov/program-basics/) environment, it's crucial to ensure that all integrated systems, including feature flagging solutions, adhere to the same compliance standards. Using a homegrown or third-party feature flag system that does not support FedRAMP standards can compromise your certification and introduce unnecessary risks.
When operating in a [FedRAMP-compliant](https://www.fedramp.gov) environment, it's crucial to ensure that all integrated systems, including feature flagging solutions, adhere to the same compliance standards. Using a homegrown or third-party feature flag system that does not support FedRAMP standards can compromise your certification and introduce unnecessary risks.
This guide provides an overview of how [Unleash Enterprise](https://www.getunleash.io/pricing) features align with FedRAMP controls, helping your organization meet its compliance requirements.

View File

@ -379,6 +379,7 @@ const sidebars: SidebarsConfig = {
'reference/segments',
'reference/unleash-context',
'reference/stickiness',
'reference/release-templates',
],
},
{

Binary file not shown.

After

Width:  |  Height:  |  Size: 148 KiB