Skip to content

feat: V2 in progress #312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
},
"rules": {
"no-undef": "off",
"no-unused-vars": "off",
"no-unused-expressions": "off"
}
}
16 changes: 8 additions & 8 deletions cloud/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ This allows Flipt Cloud to work for both mono-repo and multi-repo architectures.

<img
className="block dark:hidden"
src="/images/cloud/architecture/overview-light.svg"
src="/cloud/images/architecture/overview-light.svg"
/>
<img
className="hidden dark:block"
src="/images/cloud/architecture/overview-dark.svg"
src="/cloud/images/architecture/overview-dark.svg"
/>

## Control Plane
Expand Down Expand Up @@ -53,11 +53,11 @@ Flipt Cloud supports evaluation for our [client-side SDKs](/integration/client)

<img
className="block dark:hidden"
src="/images/cloud/architecture/client-evaluation-cloud-light.svg"
src="/cloud/images/architecture/client-evaluation-cloud-light.svg"
/>
<img
className="hidden dark:block"
src="/images/cloud/architecture/client-evaluation-cloud-dark.svg"
src="/cloud/images/architecture/client-evaluation-cloud-dark.svg"
/>

[Server-side SDKs](/integration/server) including [OpenFeature SDKs](/integration/openfeature) are also supported but currently require you to run your own Flipt instances.
Expand All @@ -72,11 +72,11 @@ To scale evaluation requests and serve feature flag evaluations via our server-s

<img
className="block dark:hidden"
src="/images/cloud/architecture/server-evaluation-self-hosted-light.svg"
src="/cloud/images/architecture/server-evaluation-self-hosted-light.svg"
/>
<img
className="hidden dark:block"
src="/images/cloud/architecture/server-evaluation-self-hosted-dark.svg"
src="/cloud/images/architecture/server-evaluation-self-hosted-dark.svg"
/>

### Client-Side Evaluation
Expand All @@ -85,11 +85,11 @@ You can also run your own Flipt Open Source instances and configure our client-s

<img
className="block dark:hidden"
src="/images/cloud/architecture/client-evaluation-self-hosted-light.svg"
src="/cloud/images/architecture/client-evaluation-self-hosted-light.svg"
/>
<img
className="hidden dark:block"
src="/images/cloud/architecture/client-evaluation-self-hosted-dark.svg"
src="/cloud/images/architecture/client-evaluation-self-hosted-dark.svg"
/>

For more information on how to deploy Flipt Open Source and how to configure it to source flag data from your Git repository, please refer to the [Moving to Production](/cloud/guides/production) guide.
20 changes: 10 additions & 10 deletions cloud/features/approval-workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ mode: "wide"

Flipt Cloud provides a built-in approval workflow system that allows you to easily manage and track the proposal and approval process for your flags, ensuring that they are approved by the appropriate stakeholders before they are released to production.

![Proposal Merged](/images/cloud/features/approval/proposal-merged.png)
![Proposal Merged](/cloud/images/features/approval/proposal-merged.png)

## Overview

Expand All @@ -28,7 +28,7 @@ The approval workflow system is designed to fit into this process, and to make i

When you create an environment in Flipt Cloud, you can choose to protect the environment. This will require that all flag and other configuration changes go through a review and approval process before they are served from the environment.

![Protected Environment](/images/cloud/features/approval/protected-environment.png)
![Protected Environment](/cloud/images/features/approval/protected-environment.png)

In our Git backed storage model, all environments have a default branch. If you chose an existing repository and branch when creating the environment and that branch is protected, the environment itself will be protected by default.

Expand All @@ -39,43 +39,43 @@ In our Git backed storage model, all environments have a default branch. If you

Protected environments are read-only and can only be changed by going through the proposal/approval process. If you are in a protected environment, you will see the 'Protected' badge in the top right of the environment.

![Protected Environment Badge](/images/cloud/features/approval/protected-badge.png)
![Protected Environment Badge](/cloud/images/features/approval/protected-badge.png)

## Approval Process

To make a change for a protected environment, you will need to put the environment into 'editing mode' by clicking on the 'Protected' badge. This will prompt a confirmation dialog asking you to confirm that you want to create a proposal branch to make your changes.

![Create Branch Dialog](/images/cloud/features/approval/create-branch-dialog.png)
![Create Branch Dialog](/cloud/images/features/approval/create-branch-dialog.png)

Once you click 'Create Branch', you will be redirected to a new environment that is no longer protected. This environment is a full read/write replica of the protected environment, but any changes you make will not be deployed to the protected environment until they are approved and merged.

![Unprotected Environment](/images/cloud/features/approval/unprotected-environment.png)
![Unprotected Environment](/cloud/images/features/approval/unprotected-environment.png)

You can make changes to the unprotected environment, and they will be captured in the proposal branch. Once you are ready to deploy your changes, you can create a pull request into the protected environment.

## Creating a Proposal

After making the changes you want to propose, you can create a proposal by clicking on the 'Propose' button in the top right of the screen. This will again prompt a confirmation dialog asking you to confirm that you want to create a new pull request in your repository and add it to the approval workflow.

![Create Proposal Dialog](/images/cloud/features/approval/create-proposal-dialog.png)
![Create Proposal Dialog](/cloud/images/features/approval/create-proposal-dialog.png)

Once you click 'Create Proposal', you will see a badge in the top right of the screen indicating that a proposal is pending, with a link to the proposal pull request.

![Proposal Pending Badge](/images/cloud/features/approval/proposal-pending.png)
![Proposal Pending Badge](/cloud/images/features/approval/proposal-pending.png)

Clicking on the badge will take you to the proposal pull request.

![Proposal Pull Request](/images/cloud/features/approval/proposal-pull-request.png)
![Proposal Pull Request](/cloud/images/features/approval/proposal-pull-request.png)

## Approve and Merge

Your team can review the proposal and approve it by clicking on the 'Approve' button in the pull request. Once the proposal is approved, you will be able to merge the pull request into the protected environment.

![Approve Pull Request](/images/cloud/features/approval/approve-pull-request.png)
![Approve Pull Request](/cloud/images/features/approval/approve-pull-request.png)

Once the pull request is merged, the changes will be deployed to the protected environment.

![Deployed Changes](/images/cloud/features/approval/deployed-changes.png)
![Deployed Changes](/cloud/images/features/approval/deployed-changes.png)

<Tip>
You can leverage GitHub's existing [Code
Expand Down
8 changes: 4 additions & 4 deletions cloud/features/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ You get social login, passwordless authentication, and multi-factor authenticati

We also support custom authentication providers, so you can integrate with your existing identity management system.

![Authentication](/images/cloud/features/auth/login.png)
![Authentication](/cloud/images/features/auth/login.png)

This flexibility allows you to choose the authentication method that best fits your organization's needs, whether you're a small startup or a large enterprise.

## Single Sign-On

Flipt Cloud supports Single Sign-On (SSO) with popular identity providers like Okta, Microsoft Active Directory, and Google Workspace. With SSO, your team members can log in to Flipt using their existing credentials, making it easy to manage access and permissions.

![Single Sign-On](/images/cloud/features/auth/sso.gif)
![Single Sign-On](/cloud/images/features/auth/sso.gif)

SSO also enhances security by reducing the number of passwords your team members need to remember and ensuring that access is granted only to authorized users.

Expand All @@ -28,8 +28,8 @@ You can even set up custom SAML and OIDC providers, so you can use your existing

To access the Flipt API for evaluation requests, you can generate API keys for each environment that you create. This key is used to authenticate your requests to the API and is available in the environment settings.

![API Access](/images/cloud/features/auth/api-access.png)
![API Access](/cloud/images/features/auth/api-access.png)

API keys are securely stored in Flipt Cloud and are used to authenticate requests made through our SDKs.

![API Key](/images/cloud/features/auth/api-key.png)
![API Key](/cloud/images/features/auth/api-key.png)
8 changes: 4 additions & 4 deletions cloud/features/custom-domains.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ This is useful if you want to use a domain (or subdomain) that you already own i

<img
className="block dark:hidden"
src="/images/cloud/features/domains/client-evaluation-cloud-light.svg"
src="/cloud/images/features/domains/client-evaluation-cloud-light.svg"
/>
<img
className="hidden dark:block"
src="/images/cloud/features/domains/client-evaluation-cloud-dark.svg"
src="/cloud/images/features/domains/client-evaluation-cloud-dark.svg"
/>

<Info>
Expand Down Expand Up @@ -76,11 +76,11 @@ Using custom domains with Flipt Cloud is a simple three step process:

1. **Configure the Domain**: Once enabled, you can add your custom domain to your Flipt Cloud environment in the Flipt Cloud UI.

![Environment Domain](/images/cloud/features/domains/environment-domain.png)
![Environment Domain](/cloud/images/features/domains/environment-domain.png)

2. **Configure the DNS**: You'll need to configure the DNS for your custom domain to point to your existing Flipt Cloud environment.

![DNS Configuration](/images/cloud/features/domains/dns-configuration.png)
![DNS Configuration](/cloud/images/features/domains/dns-configuration.png)

3. **Update Your SDKs**: Once the DNS has propagated, you simply need to update your SDKs to use the new domain.

Expand Down
4 changes: 2 additions & 2 deletions cloud/features/git-backed-storage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ mode: "wide"

Flipt Cloud is unique in that it uses your existing Git repositories for your feature flags and configurations. This means that your feature flag data is stored in a Git repository of your choosing, which allows you to use your existing Git workflow and tools.

![Git-Backed Storage](/images/cloud/features/git/feature-flag-in-repository.png)
![Git-Backed Storage](/cloud/images/features/git/feature-flag-in-repository.png)

Flipt Cloud manages your feature flags in what we call [Environments](/cloud/concepts#environments).

Expand All @@ -34,7 +34,7 @@ As developers ourselves, we understand the power of Git. It allows you to review

Because we mirror your flag data in Git, you always have the ability to 'break the glass' and make changes directly to the Git repository if needed.

![Flipt UI](/images/cloud/features/git/feature-flag-in-ui.png)
![Flipt UI](/cloud/images/features/git/feature-flag-in-ui.png)

We believe that Git is the best way to manage configuration data. We also believe that feature flags are a type of configuration data, and as such, they should be in the same way.

Expand Down
8 changes: 4 additions & 4 deletions cloud/features/rbac.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ mode: "wide"

Role-based access control allows you to define custom roles and permissions for your team members.

![Roles](/images/cloud/features/rbac/roles.png)
![Roles](/cloud/images/features/rbac/roles.png)

You can create roles with specific permissions, such as read-only access to feature flags or the ability to create new flags. This gives you fine-grained control over who can do what in Flipt Cloud and your Flipt instances.

Expand All @@ -24,15 +24,15 @@ Flipt Cloud comes with several built-in roles that you can assign to your team m
- **Editor**: Can create and update most resources, but cannot delete them. Cannot access organization settings.
- **Viewer**: Read-only access to most resources, cannot create or update them. Cannot access organization settings.

![Built-In Roles](/images/cloud/features/rbac/roles-built-in.png)
![Built-In Roles](/cloud/images/features/rbac/roles-built-in.png)

Built-in roles cannot be modified or deleted, but you can create custom roles with specific permissions to meet your organization's needs.

## Custom Roles

You can create custom roles with any permissions you need. For example, you can create a role that allows users to create and update feature flags and segments, but not delete them.

![Custom Roles](/images/cloud/features/rbac/roles-custom.png)
![Custom Roles](/cloud/images/features/rbac/roles-custom.png)

## Assigning Roles

Expand All @@ -43,7 +43,7 @@ You can assign roles to team members after you invite them to your organization
invited to your organization.
</Note>

![Assign Roles](/images/cloud/features/rbac/roles-assign.png)
![Assign Roles](/cloud/images/features/rbac/roles-assign.png)

## Role Scope

Expand Down
4 changes: 2 additions & 2 deletions cloud/features/user-management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ mode: "wide"

Flipt Cloud makes it easy to manage your team members and their permissions. You can invite users in your organization, assign roles, and control access to features and data.

![User Management](/images/cloud/features/users/team.png)
![User Management](/cloud/images/features/users/team.png)

With features like [Role-Based Access Control](/cloud/features/rbac), you can ensure that team members have the right level of access to the features they need, while keeping sensitive data secure.

![Invite Users](/images/cloud/features/users/invite.png)
![Invite Users](/cloud/images/features/users/invite.png)

## Just in Time User Provisioning

Expand Down
8 changes: 4 additions & 4 deletions cloud/features/verified-commits.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Verify Flipt's commits to your GitHub repository with SSH signing keys. This ens

You can learn more about GitHub's commit verification in the [GitHub documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification).

![Signed Commits](/images/cloud/features/verified-commits/commits.png)
![Signed Commits](/cloud/images/features/verified-commits/commits.png)

<Info>
Verified Commits are only available on our Team plan and above. See our
Expand All @@ -21,11 +21,11 @@ To verify commits with Flipt Cloud, we'll need to create a
signing key, as Flipt needs to be able to sign the commits it
creates itself.

![Generate Key](/images/cloud/features/verified-commits/generate-key.png)
![Generate Key](/cloud/images/features/verified-commits/generate-key.png)

To do this, head to your user settings in Flipt Cloud, and click 'Generate Key'.

![Signing Key](/images/cloud/features/verified-commits/signing-key.png)
![Signing Key](/cloud/images/features/verified-commits/signing-key.png)

Copy the key as you'll need to add it to GitHub in the next step.

Expand All @@ -38,7 +38,7 @@ It must be a signing key, rather than an authentication
key, as we don't want this key to be able to push to your repositories, just to
verify commits.

![Add Key](/images/cloud/features/verified-commits/add-signing-key.png)
![Add Key](/cloud/images/features/verified-commits/add-signing-key.png)

## How We Store Your Key

Expand Down
20 changes: 10 additions & 10 deletions cloud/guides/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,23 +26,23 @@ Before you get started with Flipt Cloud, you need to have the following:

Once you are logged in, you will see the Flipt Cloud dashboard. Click on `Create Environment`.

![Create Environment](/images/cloud/guides/getting-started/dashboard.png)
![Create Environment](/cloud/images/guides/getting-started/dashboard.png)

</Step>

<Step title="Name Your Environment">

Give your environment a name and description to help you identify it later.

![Name Environment](/images/cloud/guides/getting-started/environment-form.png)
![Name Environment](/cloud/images/guides/getting-started/environment-form.png)

</Step>

<Step title="Authorize GitHub">

If you haven't already connected your GitHub account, you'll be prompted to install our GitHub App in your organization.

![Authorize GitHub](/images/cloud/guides/getting-started/authorize-github.png)
![Authorize GitHub](/cloud/images/guides/getting-started/authorize-github.png)

Select the repositories you want to allow Flipt Cloud to access, or select all repositories.

Expand All @@ -52,7 +52,7 @@ Select the repositories you want to allow Flipt Cloud to access, or select all r

Select the repository you want to store your feature flags and configurations in, or create a new one.

![Select Repository](/images/cloud/guides/getting-started/select-repository.png)
![Select Repository](/cloud/images/guides/getting-started/select-repository.png)

You can also specify a branch or use the default branch.

Expand All @@ -69,15 +69,15 @@ Optionally choose a path for your feature flags and configurations.

You can choose to store your feature flags and configurations in the root of your repository, or in a subdirectory. If it doesn't exist, it will be created.

![Choose Path](/images/cloud/guides/getting-started/choose-path.png)
![Choose Path](/cloud/images/guides/getting-started/choose-path.png)

</Step>

<Step title="Create Environment">

Finally, click on `Done` to create your environment.

![Create Environment](/images/cloud/guides/getting-started/done.png)
![Create Environment](/cloud/images/guides/getting-started/done.png)

</Step>

Expand All @@ -87,15 +87,15 @@ You will be redirected to the environment dashboard.

Click on your new environment to open up the Flipt UI.

![Flipt UI](/images/cloud/guides/getting-started/flipt-ui.png)
![Flipt UI](/cloud/images/guides/getting-started/flipt-ui.png)

</Step>

<Step title="Create a Feature Flag">

Create a new feature flag by clicking on the `Flags` menu and then clicking on the `New Flag` button.

![Create Feature Flag](/images/cloud/guides/getting-started/create-flag.png)
![Create Feature Flag](/cloud/images/guides/getting-started/create-flag.png)

See the [Getting Started](/introduction#create-a-flag) guide in Open Source for more information on how to create a feature flag.

Expand All @@ -107,7 +107,7 @@ Click on your new environment to open up the Flipt UI.

Go to your repository in GitHub and you will see the feature flag you created.

![Repository](/images/cloud/guides/getting-started/repository.png)
![Repository](/cloud/images/guides/getting-started/repository.png)

The feature flag will be stored in the path you specified, or in the root of your repository if you didn't specify a path.

Expand All @@ -116,7 +116,7 @@ Click on your new environment to open up the Flipt UI.
in your repository.
</Tip>

![Feature Flag in Repository](/images/cloud/guides/getting-started/feature-flag-in-repository.png)
![Feature Flag in Repository](/cloud/images/guides/getting-started/feature-flag-in-repository.png)

</Step>
</Steps>
Expand Down
Loading