diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index db53107c..14ecfec8 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,13 +1,12 @@ name: CI -on: - - pull_request +on: [pull_request] jobs: lint: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Setup Node.js uses: actions/setup-node@v3 @@ -19,3 +18,8 @@ jobs: - name: Lint run: yarn lint + + - name: Check for Broken Links + run: | + yarn global add mintlify + mintlify broken-links diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml index ba3541f9..c586225e 100644 --- a/.github/workflows/vale.yml +++ b/.github/workflows/vale.yml @@ -6,5 +6,5 @@ jobs: name: Vale runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: errata-ai/vale-action@reviewdog diff --git a/.vale.ini b/.vale.ini index 954d9fb8..06dfaa38 100644 --- a/.vale.ini +++ b/.vale.ini @@ -18,6 +18,7 @@ Microsoft.Foreign = warning Microsoft.URLFormat = warning Microsoft.RangeFormat = warning Microsoft.Contractions = warning +Microsoft.Dashes = warning Openly.A11Y = warning Openly.Punctuation = warning diff --git a/.vale/styles/Flipt/spelling-exceptions.txt b/.vale/styles/Flipt/spelling-exceptions.txt index c8cc88b1..b10952f3 100644 --- a/.vale/styles/Flipt/spelling-exceptions.txt +++ b/.vale/styles/Flipt/spelling-exceptions.txt @@ -23,6 +23,7 @@ enum flagd flipt flipt's +git's Gitlab gitops googlecloud @@ -43,6 +44,8 @@ linux memcached Minio mintlify +monorepo +multi-repo namespace namespaced namespaces diff --git a/README.md b/README.md index 7113c43c..e74e1479 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ We also use a [custom style](https://docs.errata.ai/vale/styles) to lint our doc ### Spelling Errors -If Vale detects a spelling error, it will output it as an error to the console. If you want to ignore a spelling error, you can add the word to the [spelling-execeptions](./vale/styles/Flipt/spelling-exceptions.txt) file in our custom style. +If Vale detects a spelling error, it will output it as an error to the console. If you want to ignore a spelling error, you can add the word to the spelling-execeptions (`.vale/styles/Flipt/spelling-exceptions.txt`) file in our custom style. β„Ή The words in this file are case-insensitive, please add the word in lowercase and in alphabetical order. diff --git a/cli/commands/cloud/login.mdx b/cli/commands/cloud/login.mdx deleted file mode 100644 index 9b74ca92..00000000 --- a/cli/commands/cloud/login.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "cloud login" -description: "Authenticate with Flipt Enterprise Cloud" ---- - -``` -flipt cloud login [flags] -``` - -## Prerequisites - -Before you get started with Flipt Enterprise Cloud, you need to have the following: - -1. An active Flipt Enterprise Cloud account. If you don't have an account yet, [sign up here](https://flipt.cloud). -2. Enable the `cloud` experimental feature in the Flipt configuration file. You can enable the `cloud` feature by adding the following configuration to your `flipt.yaml` file: - -```yaml -experimental: - cloud: - enabled: true -``` - -### Options - -``` - -h, --help help for edit -``` - -### Inherited Options - -``` - -u, --url string Flipt Cloud URL (default "https://flipt.cloud") -``` - -### More Info - -See the [cloud](/cloud/overview) section of the documentation for more information on Flipt Enterprise Cloud. diff --git a/cli/commands/cloud/logout.mdx b/cli/commands/cloud/logout.mdx deleted file mode 100644 index 9c7f2c47..00000000 --- a/cli/commands/cloud/logout.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "cloud logout" -description: "Logout from Flipt Enterprise Cloud" ---- - -``` -flipt cloud logout -``` - -## Prerequisites - -Before you get started with Flipt Enterprise Cloud, you need to have the following: - -1. An active Flipt Enterprise Cloud account. If you don't have an account yet, [sign up here](https://flipt.cloud). -2. Enable the `cloud` experimental feature in the Flipt configuration file. You can enable the `cloud` feature by adding the following configuration to your `flipt.yaml` file: - -```yaml -experimental: - cloud: - enabled: true -``` - -### Options - -``` - -h, --help help for edit -``` - -### More Info - -See the [cloud](/cloud/overview) section of the documentation for more information on Flipt Enterprise Cloud. diff --git a/cloud/architecture.mdx b/cloud/architecture.mdx new file mode 100644 index 00000000..88d292ac --- /dev/null +++ b/cloud/architecture.mdx @@ -0,0 +1,89 @@ +--- +title: Architecture +description: Learn about the architecture of Flipt Managed Cloud and how it scales to meet your needs +mode: "wide" +--- + +This section describes the high-level architecture of Flipt Managed Cloud and how you can also run you own Flipt instances for evaluation purposes while still leveraging the managed service. + +## Overview + +Each Flipt Managed Cloud instance is a fully managed Flipt instance that is hosted and operated by the Flipt team. + +Each organization gets a dedicated Flipt instance, eliminating the noisy neighbor problem. + +Each environment is a logical grouping of feature flags and namespaces that share the same backend Flipt instance. + +Feature flags in each environment are isolated from each other, preventing naming conflicts and improving organization. You have the option to have multiple environments share the same underlying Git repository, allowing you to manage your feature flags in a single location, or have each environment have its own Git repository. + +This allows Flipt Managed Cloud to work for both monorepo and multi-repo architectures. + + + + +## Control Plane + +Flipt Managed Cloud operates as a control plane for your Flipt environments, providing a single point of entry for all of your feature flagging needs. You login to the Flipt Managed Cloud UI and create and manage your feature flags through the UI. Feature flag data is stored in the Git repository you specify in the Flipt Managed Cloud UI. + +Flipt Managed Cloud also handles authentication and authorization for your Flipt environments. Flipt managed Cloud works with many popular identity and single sign-on providers, including Google, Okta, and Auth0. + +## Data Plane + +Each Flipt environment is backed by a Flipt instance. The Flipt instance is hosted and operated by the Flipt team. This means you don't need to deploy or manage Flipt instances yourself. + +These environments act as the data plane to serve feature flag data to your applications. When you create a feature flag in the Flipt Managed Cloud UI, it is stored in the Git repository you specify in the Flipt Managed Cloud UI. When you make a request to evaluate a feature flag, the Flipt instance in the Flipt Managed Cloud environment serves the feature flag data to your application. + +Each Flipt environment gets its own unique URL that you use to serve feature flag data to your applications. Our SDKs and API clients use this URL to connect to the Flipt instance in the Flipt Managed Cloud environment. + +## Evaluation + +Flipt Managed Cloud supports evaluation for our [client-side SDKs](/integration/client) out of the box. These SDKs are available for many popular programming languages, including JavaScript, TypeScript, Go, Java, Ruby, Python, and more. These client-side SDKs are designed with performance in mind, and store feature flag data in memory to serve feature flag evaluations quickly. + + + + +[Server-side SDKs](/integration/server) including [OpenFeature SDKs](/integration/openfeature) are also supported, but currently require you to run your own Flipt instances. + +### Self-Hosted Flipt + +[Open Source Flipt](/) is available for self-hosting and can mirror your feature flag configurations from Flipt Managed Cloud. This is useful if you want to use Flipt Managed Cloud for configuring and managing your feature flags, while still using your own Flipt instances for evaluation, allowing you to scale and maintain availability within your own infrastructure. + +### Server-Side Evaluation + +To scale evaluation requests and serve feature flag evaluations via our server-side SDKs, you can deploy Flipt Open Source and configure it to source flag data from your Git repository. + + + + +### Client-Side Evaluation + +You can also run your own Flipt Open Source instances and configure our client-side SDKs to connect to your Flipt instances. This again allows you to use Flipt Managed Cloud for managing your feature flags, while still using your own Flipt instances for evaluation for performance, stability and/or security reasons. + + + + +For more information on how to deploy Flipt Open Source and configure it to source flag data from your Git repository, please refer to the [Moving to Production](/cloud/guides/production) guide. diff --git a/cloud/architecture/overview.mdx b/cloud/architecture/overview.mdx deleted file mode 100644 index 6acf5adc..00000000 --- a/cloud/architecture/overview.mdx +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: Technical Details -description: Learn the technical details of how Flipt Enterprise Cloud works -mode: "wide" ---- - -This page details how Flipt Enterprise Cloud is built to provide a simple and scalable solution for accessing and securing your internal, self-hosted deployments of Flipt. - -Flipt comes baked with lots of critical features for scale and security, including: - -- Ability to scale horizontally -- HTTPS/TLS support -- Configurable [authentication mechanisms](/configuration/authentication) (Static Token, OIDC, GitHub, JWT and Kubernetes, etc.) -- API and UI with session management and termination - -These capabilities are super important for deploying Flipt into your infrastructure and making it secure for your users. -However, enabling and integrating these features isn't free of complexities, infrastructure, and time investment. - -In order to take advantage of these, you're likely going to have to perform one or more of the following actions: - -- Enable networking and routing to your Flipt instance (e.g. open ports, configure firewalls, VPN, etc.) -- Issue and assign an (internal or external) DNS name for your Flipt -- Add a load-balancer to distribute load across your instances of Flipt -- Issue TLS certificates and manage their rotation over time -- Manually configure OAuth client credentials for your SSO provider for OIDC authentication -- Deploy and manage a database for Flipt to store session credentials in - - - - -Flipt Cloud replaces all these steps with a few clicks and some API credentials. - -## Flipt the Problem on its Head - -Flipt Enterprise Cloud reverses the ingress problem so that your deployments of Flipt dial out to us instead. -This approach is commonly referred to as _reverse tunneling_. -Tunneling in this way has several advantages for applications, as they can be deployed in environments without a stable IP address (e.g. behind restrictive NATs). -For Flipt, this means you can safely expose Flipt from inside a major cloud provider, a modern hyperscaler or simply from your own laptop on your home network. - - - - -When you register your instance in this way with Flipt Enterprise Cloud, we issue you with a stable subdomain under `flipt.cloud` (e.g. `production-megacorp.flipt.cloud`). - -Using this DNS name, requests for your instances will flow though our API gateways, load-balancers and then only reach your instances once fully authenticated. - - - Instances, environments, gateways.. what's the difference? Check out our - [concepts](/cloud/concepts) page for more details. - - -This entire process is performed over secure TLS connections from your end users back to your instances. -All of which is done without you having to provide TLS certificates, and without having to manage certificate rotation. - -## Tunnel Registration - -Your connections are made using an API key credential obtained from our Flipt Enterprise Cloud UI, or via the `flipt cloud login` sub-command of the Flipt CLI. -This credential is used in an initial handshake to identify your Flipt Enterprise Cloud organization and the logical environment your Flipt is joining. - - - - -Once registered and associated with Flipt Enterprise Cloud, your Flipt instance is added to our remote load balancer pool for your logical environment. -Now when you visit your new Flipt Enterprise Cloud environment subdomain, your requests are routed to the instances deployed on your infrastructure. - -The majority of the tunneling functionality we perform is provided by our open-source project [Reverst](https://github.com/flipt-io/reverst). -Reverst is unique in that it leverages HTTP/3 and the QUIC protocol to establish secure, reliable, and performant connections for tunnels. - -Check out our [blog post](https://blog.flipt.io/so-we-built-reverst) on how and why we chose to build our reverse tunnels in this way. - -We deploy and scale multiple instances of Reverst on our infrastructure for establishing and managing these tunnels for you, all while tightly integrating them with the Flipt Enterprise Cloud user interface, authentication, and environment management system. - -Have more questions about how Flipt Enterprise Cloud works? Send us an email at `info@flipt.io` and ask away! We're always happy to help. diff --git a/cloud/benefits.mdx b/cloud/benefits.mdx index 11239b80..5cbb9268 100644 --- a/cloud/benefits.mdx +++ b/cloud/benefits.mdx @@ -1,29 +1,59 @@ --- title: Benefits -description: Discover the benefits of Flipt Enterprise Cloud and why it's the best choice for your organization +description: Discover the benefits of Flipt Managed Cloud and why it's the best choice for your organization mode: "wide" --- -At Flipt, we aim to provide the best possible feature flagging experience for our users. That's why we're excited to introduce Flipt Enterprise Cloud, a new offering that combines the best of both worlds: the simplicity and flexibility of open-source Flipt with the scalability and reliability of a managed cloud service. + + Flipt Managed Cloud is currently in beta. Some functionality may be subject to + change. -## We Hate Limits +Interested in joining the beta? [Request access here](https://flipt.cloud). -One of the biggest challenges with traditional feature flagging solutions is that they often come with limits. Whether it's the number of flags you can create, the number of users you can have, or the amount of data you can store, these limits can be frustrating and restrictive. With Flipt Enterprise Cloud, we've removed these limits, giving you the freedom to create as many flags as you need, invite as many users as you want, and store as much data as you require. + -We believe that you should never have to worry about hitting a limit or being charged extra for using too much of a service. With Flipt Enterprise Cloud, you can focus on building great products without having to worry about artificial constraints. +At Flipt, we aim to provide the best possible feature flagging experience for our users. That's why we're excited to introduce Flipt Managed Cloud, a new offering that combines the best of both worlds: the simplicity and flexibility of a managed cloud service with the scalability and reliability of self-hosted Flipt. + +## Limitless Scalability + +One of the biggest challenges with traditional feature flagging solutions is that they often come with limits. Whether it's the number of flags you can create, the number of evaluations/requests you can make, or the amount of data you can store, these limits can be frustrating and restrictive. With Flipt Managed Cloud, we've removed these limits, giving you the freedom to create as many flags as you need, invite as many users as you want, and store as much data as you require. + +We believe that you should never have to worry about hitting a limit or being charged extra for using too much of a service. With Flipt Managed Cloud, you can focus on building great products without having to worry about artificial constraints. ## The Best of Both Worlds -We believe the future is hybrid. You shouldn't have to decide between security and control or scalability and reliability. Traditional SaaS solutions force you to give up control over your data in exchange for convenience, while self-hosted and in-house solutions lack features that enterprise customers need. +Traditional SaaS solutions force you to give up control over your data in exchange for convenience, while self-hosted and in-house solutions lack features that enterprise customers need. + +With Flipt Managed Cloud, you get the best of both worlds. You get the security, convenience and ease of use of a managed SaaS solution, along with the control and ability to own your own data that self-hosted solutions provide. + +Our platform provides the essential features and functionality for building great products, all without compromising on security, control, or scalability. + +## GitOps and ClickOps Friendly + +Flipt Managed Cloud offers a unique approach to feature flag management by storing your feature flag data in a Git repository of your choosing. This innovative method brings several key benefits: + +1. **Data Sovereignty**: By keeping your feature flag configurations in your own Git repository, you maintain full control over your data. You decide where it's stored, who has access, and how it's managed, ensuring compliance with data regulations and internal policies. + +2. **Zero Lock-in**: With your feature flag data in a standard Git format, you're never locked into our platform. You can easily export or migrate your data at any time, giving you the freedom to switch providers or solutions as your needs evolve. Using Flipt open-source in conjunction with Flipt managed cloud, means you can step away from managed cloud at any point. Your applications will continue to be served by your own self-hosted instances, from configuration stored in repositories you own. + +3. **Familiar Developer Workflow**: Storing feature flags alongside your code allows developers to work with tools they already know and love. They can use their preferred Git workflows, code review processes, and CI/CD pipelines to manage feature flags just like any other code changes. + +4. **Version Control, Audit Trail, and Instant Rollback**: Git's inherent version control capabilities provide a comprehensive audit trail for all feature flag changes. This makes it easy to track who made what changes, when, and why – crucial for debugging and compliance. Also, if a flag change causes issues, you can quickly roll back to a previous state using Git's revert capabilities, minimizing downtime and impact on users. + +5. **Environment Consistency**: By treating feature flags as code, you can ensure consistency across different environments. Use branching strategies to manage feature flags for development, staging, and production environments, just as you would with application code. + +6. **Collaboration and Code Reviews**: Leverage Git's collaboration features for feature flag management. Use pull requests to review and discuss flag changes before they're implemented, fostering better communication and reducing errors. + +While these Git-based features offer powerful capabilities for technical users, Flipt Managed Cloud is designed to be accessible to all. Our intuitive user interface allows non-technical team members to easily manage feature flags without any knowledge of Git. They can create, update, and toggle flags through our user-friendly dashboard, while behind the scenes, Flipt handles the Git operations seamlessly. -With Flipt Enterprise Cloud, you get the best of both worlds. You get the security, performance, and control which comes with self-hosting, with the convenience and ease of use of a SaaS solution. You get the features and functionality you need to build great products, without having to compromise on security, control, or scalability. +This hybrid approach ensures that both technical and non-technical users can collaborate effectively, leveraging the power of Git-based workflows without the complexity. It's the perfect balance of power and simplicity, making Flipt Managed Cloud an ideal solution for teams of all sizes and technical backgrounds. ## Enterprise Ready -We understand that enterprise customers have unique needs and requirements. That's why we've designed Flipt Enterprise Cloud to be enterprise-ready from day one. With features like directory sync, single sign-on, and advanced user management, you can be confident that Flipt Enterprise Cloud will meet the needs of your organization. +We understand that enterprise customers have unique needs and requirements. That's why we've designed Flipt Managed Cloud to be enterprise-ready from day one. With features like directory sync, single sign-on, and role-based access control, you can be confident that Flipt Managed Cloud will meet the needs of your organization. -Security is our top priority, and we've built Flipt Enterprise Cloud with security in mind. With features role-based access control, audit logs, and encrypted connections between Flipt Enterprise Cloud and your infrastructure, you can be confident that your data is safe and secure. +Our scalable infrastructure is designed to handle high-volume traffic and complex flag evaluations, making Flipt Managed Cloud suitable for organizations of any size, from startups to large enterprises with global operations. ## Get Started Today -We're excited to bring Flipt Enterprise Cloud to market, and we can't wait for you to try it out. If you're interested in learning more about Flipt Enterprise Cloud or signing up for the beta, check out our [website](https://flipt.io/cloud). +We're excited to bring Flipt Managed Cloud to market, and we can't wait for you to try it out. If you're interested in learning more about Flipt Managed Cloud or signing up for the beta, check out our [website](https://flipt.io/cloud). diff --git a/cloud/concepts.mdx b/cloud/concepts.mdx index f8507f25..a9dcfe9f 100644 --- a/cloud/concepts.mdx +++ b/cloud/concepts.mdx @@ -1,33 +1,58 @@ --- title: Concepts -description: This document describes the basic concepts of Flipt Enterprise Cloud. +description: This document describes the basic concepts of Flipt Managed Cloud. --- -Flipt Enterprise Cloud allows you to run Flipt on your infrastructure with the added benefits of a managed service. This document describes the basic concepts of Flipt Enterprise Cloud. + + Flipt Managed Cloud is currently in beta. Some functionality may be subject to + change. -## Enterprise Cloud +Interested in joining the beta? [Request access here](https://flipt.cloud). -With Flipt Enterprise Cloud, you deploy open-source Flipt on your infrastructure or cloud provider of choice as you always have, and we provide you with effortless ingress, enterprise-grade authentication and authorization. Experience a seamless transition with enhanced features that fit perfectly into your existing setup. + -## Gateways +Flipt Managed Cloud is a fully managed solution where we host and operate Flipt for you. You no longer need to deploy or manage Flipt instances yourself. We provide a secure, scalable, and feature-rich environment with enterprise-grade authentication and authorization built-in. -A gateway is a secure tunnel that allows Flipt Enterprise Cloud to connect to your local Flipt instance. When you run `flipt` with Enterprise Cloud, we create a secure tunnel to your local instance via a gateway, allowing you to access it from anywhere in the world. +While Flipt Managed Cloud is a completely managed service, it works hand in hand with Flipt Open Source. You can still deploy Flipt Open Source in your own infrastructure to scale as needed, while still using Flipt Managed Cloud for feature flag management. - - See our [Production Guide](/cloud/guides/production) for more information on - how to connect your instances to Flipt Enterprise Cloud. - +Here are some of the basic concepts in Flipt Managed Cloud: + +## Git-Backed Storage + +Flipt Managed Cloud leverages Git repositories as the backbone for storing and managing your feature flag configurations. This innovative approach allows you to store your feature flag data in your own GitHub repositories, providing a unique blend of managed service convenience and data ownership. + +See the [Git-Backed Storage](/cloud/features/git-backed-storage) page for more information. ## Environments -An environment is a logical grouping of your Flipt instances. When you connect your Flipt instance to Flipt Enterprise Cloud, you are connecting it to a named environment. You can think of environments as a way to group your instances by purpose, such as development, staging, or production. +Environments in Flipt Managed Cloud are high-level groupings of feature flags and namespaces. They provide a way to organize and manage your feature flags across different stages of your development lifecycle or across various applications within your organization. + +Key points about environments: + +- **Logical Separation**: Environments allow you to logically separate your feature flags, making it easier to manage flags for different purposes (e.g., development, staging, production). +- **Independent Configuration**: Each environment can have its own set of feature flags, namespaces, and configurations, allowing for independent management and testing. + +## Namespaces + +Within each environment, Flipt Managed Cloud uses namespaces to further organize and group related feature flags. + +Key points about namespaces: + +- **Granular Organization**: Namespaces allow you to group related flags together, such as by team, feature set, or application component. +- **Isolation**: Flags in different namespaces are isolated from each other, preventing naming conflicts and improving organization. +- **Flexible Hierarchy**: You can create multiple namespaces within an environment, allowing for a flexible hierarchy that suits your organizational needs. +- **Managed Access Control**: Roles can be scoped to limit access to specific sets of namespaces. + +By utilizing environments and namespaces effectively, you can create a well-organized and scalable feature flag management system that grows with your organization's needs. -Multiple instances can be connected to the same environment if you wish. However, traffic will be routed round-robin style to each instance in the environment. +## Sources -Environments and gateways can be thought of as logically the same. When you connect your Flipt instance to an environment, you are creating a secure tunnel to your instance via a gateway. +Sources in Flipt Managed Cloud are the connection points between your environments and our managed storage, implemented as Git repositories on GitHub. They play a crucial role in how your feature flag data is stored, versioned, and managed. -## Instances +Key points about sources: -An instance is a single running instance of Flipt. When you connect your Flipt instance to Flipt Enterprise Cloud, you are connecting a single instance to an environment. +- **Git-Backed Storage**: Each source maps an environment to a specific Git repository, leveraging the power of version control for your feature flag configurations. +- **Data Sovereignty**: By using your own GitHub repositories, you maintain full control over your feature flag data, ensuring compliance with data regulations and internal policies. +- **Version Control**: Sources provide a comprehensive audit trail for all feature flag changes, making it easy to track who made what changes, when, and why. -Instances run in your infrastructure or cloud provider of choice. Flipt Enterprise Cloud provides a secure tunnel to your instance via a gateway, allowing you to access it from anywhere in the world securely and easily. +Sources in Flipt Managed Cloud combine the benefits of Git-based version control with the ease of use of a managed service, providing a flexible and powerful foundation for your feature flag management. diff --git a/cloud/features/audit-logs.mdx b/cloud/features/audit-logs.mdx deleted file mode 100644 index d4043b3b..00000000 --- a/cloud/features/audit-logs.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Audit Logs -description: Learn about centralized audit logs in Flipt Enterprise Cloud -mode: "wide" ---- - -Flipt Enterprise Cloud provides centralized audit logs to help you track changes to your feature flags and configurations. With audit logs, you can see who made changes, when they were made, and what changes were made. This makes it easy to track changes, troubleshoot issues, and maintain a history of your feature flag configurations. - - - Currently, audit logs are only available if Flipt is running with one of our - [relational database backends](/configuration/storage#relational-database). - We' re working on adding support for other storage backends in the future. - - -![Audit Event](/images/cloud/features/audit-event.png) - -Audit logs are available for all changes made in your Flipt instances and can be accessed from the Flipt Enterprise Cloud dashboard. - -You can opt specific instances in or out of audit logging to ensure that you are only tracking the changes in environments that are important to you. - -## Filtering and Search - -You can filter audit logs by user, date, and event type to quickly find the information you need. - -![Audit Logs](/images/cloud/features/audit-list.png) - -## Downloading and Retention - -Audit logs can be downloaded in CSV format for further analysis or archiving for the last 30 days. You can request a longer retention period for your audit logs by contacting Flipt support. diff --git a/cloud/features/authentication.mdx b/cloud/features/authentication.mdx index e1039a72..f4eaaca7 100644 --- a/cloud/features/authentication.mdx +++ b/cloud/features/authentication.mdx @@ -1,25 +1,34 @@ --- title: Authentication -description: Learn about the authentication options available with Flipt Enterprise Cloud -mode: "wide" +description: Learn about the authentication options available with Flipt Managed Cloud --- -Flipt Enterprise Cloud supports multiple authentication methods, including email/password, Google, and GitHub. You can also use [Single Sign-On (SSO)](#single-sign-on) with providers like Okta, Microsoft Active Directory, and Google Workspace. +Flipt Managed Cloud supports multiple authentication methods, including email/password, Google, and GitHub. You can also use [Single Sign-On (SSO)](#single-sign-on) with providers like Okta, Microsoft Active Directory, and Google Workspace. You get social login, passwordless authentication, and multi-factor authentication out of the box for **free**. We also support custom authentication providers, so you can integrate with your existing identity management system. -![Authentication](/images/cloud/features/login.png) +![Authentication](/images/cloud/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 Enterprise 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. +Flipt Managed 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/sso.png) +![Single Sign-On](/images/cloud/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. -You can even setup custom SAML and OIDC providers, so you can use your existing identity management system with Flipt Enterprise Cloud, even if it's not one of our supported identity providers. +You can even setup custom SAML and OIDC providers, so you can use your existing identity management system with Flipt Managed Cloud, even if it's not one of our supported identity providers. + +## API Access + +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 keys are securely stored in Flipt Managed Cloud and are used to authenticate requests made through our SDKs. + +![API Key](/images/cloud/features/auth/api-key.png) diff --git a/cloud/features/git-backed-storage.mdx b/cloud/features/git-backed-storage.mdx new file mode 100644 index 00000000..7d166120 --- /dev/null +++ b/cloud/features/git-backed-storage.mdx @@ -0,0 +1,41 @@ +--- +title: Git-Backed Storage +description: Learn about the unique benefits of using Git-backed storage with Flipt Managed Cloud +mode: "wide" +--- + +## What Is Git-Backed Storage? + +Flipt Managed 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) + +Flipt Managed Cloud manages your feature flags in what we call [Environments](/cloud/concepts#environments). + +Each environment can be connected to a different Git repository, allowing you to manage your feature flags in different repositories for different environments. + + + Environments can also share the same Git repository, as long as they are in + configured to use different directories. + + +## Why Use Git-Backed Storage? + +Git lives at the heart of Flipt Managed Cloud. It allows you to use your existing Git workflow and tools, and it allows you to version your configuration data. However, we understand that not everyone is familiar with Git, and that it can be intimidating to use. + +To solve for this, Flipt Managed Cloud includes a friendly UI for managing your feature flags, so that you can easily change their state without even knowing that Git is used under the hood. + + + For more info on the benefits of using Git-backed storage, see the + [Benefits](/cloud/benefits#gitops-and-clickops-friendly) page. + + +As developers ourselves, we understand the power of Git. It allows you to review and merge changes, and it allows you to see the history of your changes, quickly reverting to a previous state if needed. + +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) + +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 managed in the same way. + +By combining the power of Git with a user-friendly interface, Flipt Managed Cloud offers the best of both worlds: the robustness and version control of Git-backed storage, and the ease of use of a modern feature flag management system. diff --git a/cloud/features/rbac.mdx b/cloud/features/rbac.mdx index 31c9ac3d..7857b7cc 100644 --- a/cloud/features/rbac.mdx +++ b/cloud/features/rbac.mdx @@ -1,24 +1,23 @@ --- title: Role Based Access Control -description: Learn about the role-based access control options available with Flipt Enterprise Cloud -mode: "wide" +description: Learn about the role-based access control options available with Flipt Managed Cloud --- Role-based access control allows you to define custom roles and permissions for your team members. -![Roles](/images/cloud/features/roles.png) +![Roles](/images/cloud/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 Enterprise Cloud and your Flipt instances. +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 Managed Cloud and your Flipt instances. ## Built-in Roles -Flipt Enterprise Cloud comes with several built-in roles that you can assign to your team members: +Flipt Managed Cloud comes with several built-in roles that you can assign to your team members: - **Admin**: Full access to all resources and settings - **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/roles-built-in.png) +![Built-In Roles](/images/cloud/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. @@ -26,7 +25,7 @@ Built-in roles cannot be modified or deleted, but you can create custom roles wi 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/roles-custom.png) +![Custom Roles](/images/cloud/features/rbac/roles-custom.png) ## Assigning Roles @@ -37,10 +36,10 @@ You can assign roles to team members after you invite them to your organization invited to your organization. -![Assign Roles](/images/cloud/features/roles-assign.png) +![Assign Roles](/images/cloud/features/rbac/roles-assign.png) ## Role Scope -Roles are global across your organization, so a team member's role applies to all environments and instances in your organization. +Roles are global across your organization, so a team member's role applies to all environments in your organization. -When your team members route to a Flipt instance through Flipt Enterprise Cloud, their permissions are enforced based on the role assigned to them in the organization. +When your team members route to a Flipt instance through Flipt Managed Cloud, their permissions are enforced based on the role assigned to them in the organization. diff --git a/cloud/features/user-management.mdx b/cloud/features/user-management.mdx index cc4663c5..ce15025e 100644 --- a/cloud/features/user-management.mdx +++ b/cloud/features/user-management.mdx @@ -1,17 +1,17 @@ --- title: User Management -description: Learn about the user and team management options available with Flipt Enterprise Cloud +description: Learn about the user and team management options available with Flipt Managed Cloud mode: "wide" --- -Flipt Enterprise 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. +Flipt Managed 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/team.png) +![User Management](/images/cloud/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/invite.png) +![Invite Users](/images/cloud/features/users/invite.png) ## Just in Time User Provisioning -With our [SSO](/cloud/features/authentication##single-sign-on) and Directory Sync features, you can automatically provision users in Flipt Enterprise Cloud when they log in for the first time. This makes it easy to manage access and permissions for your team members, without having to manually invite or create users. +With our [SSO](/cloud/features/authentication##single-sign-on) and Directory Sync features, you can automatically provision users in Flipt Managed Cloud when they log in for the first time. This makes it easy to manage access and permissions for your team members, without having to manually invite or create users. diff --git a/cloud/guides/getting-started.mdx b/cloud/guides/getting-started.mdx new file mode 100644 index 00000000..7b58b10a --- /dev/null +++ b/cloud/guides/getting-started.mdx @@ -0,0 +1,139 @@ +--- +title: Getting Started +description: Learn how to get started with Flipt Managed Cloud +--- + + + Flipt Managed Cloud is currently in beta. Some functionality may be subject to + change. + +Interested in joining the beta? [Request access here](https://flipt.cloud). + + + +## Prerequisites + +Before you get started with Flipt Managed Cloud, you need to have the following: + +1. An active Flipt Managed Cloud account. If you don't have an account yet, [request access here](https://flipt.cloud). +2. An active GitHub account. If you don't have an account yet, [sign up on GitHub](https://github.com). + +## Create a New Environment + + + + First, log in to the Flipt Managed Cloud web interface. You can access the login page at [https://flipt.cloud](https://flipt.cloud). + + + + +Once you are logged in, you will see the Flipt Managed Cloud dashboard. Click on `Create Environment`. + +![Create Environment](/images/cloud/guides/getting-started/dashboard.png) + + + + + +Give your environment a name and description to help you identify it later. + +![Name Environment](/images/cloud/guides/getting-started/environment-form.png) + + + + + +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) + +Select the repositories you want to allow Flipt Managed Cloud to access, or select all repositories. + + + + + +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) + +You can also specify a branch or use the default branch. + + + + + +Optionally choose a path for your feature flags and configurations. + + + If you don't specify a path, your feature flags and configurations will be + stored in the root of your repository. + + +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) + + + + + +Finally, click on `Done` to create your environment. + +![Create Environment](/images/cloud/guides/getting-started/done.png) + + + + + +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) + + + + + + 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) + + See the [Getting Started](/introduction#create-a-flag) guide in Open Source for more information on how to create a feature flag. + + Click on `Create`. + + + + + + Go to your repository in GitHub and you will see the feature flag you created. + + ![Repository](/images/cloud/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. + + + Each namespace within Flipt Managed Cloud is represented as an additional + subdirectory in your repository. + + + ![Feature Flag in Repository](/images/cloud/guides/getting-started/feature-flag-in-repository.png) + + + + +## What's Next? + +You can now start using Flipt Managed Cloud to manage your feature flags and configurations. πŸŽ‰ + +After you've created your feature flags, you can start using them in your application. + +You can also invite other users to your environment in the Flipt Managed Cloud control plane and manage their permissions. + +See the [Moving to Production](/cloud/guides/production) guide for more information on how to manage users, permissions, and how to connect your code to your Flipt Managed Cloud environment for evaluation. + +## Questions? + +If you have any questions or need further assistance, please ask in either our [Discord channel](https://flipt.io/discord) or [Flipt Community Discourse](https://community.flipt.io/c/flipt-cloud/6). diff --git a/cloud/guides/production.mdx b/cloud/guides/production.mdx index c8b208fc..894d5a27 100644 --- a/cloud/guides/production.mdx +++ b/cloud/guides/production.mdx @@ -1,155 +1,187 @@ --- title: Moving to Production -description: Learn how go to production with Flipt Enterprise Cloud +description: Learn how to scale your feature flagging operations with Flipt Managed Cloud --- - Flipt Enterprise Cloud is currently in beta. Visit our - [website](https://flipt.io/cloud) to learn more and sign up today! + Flipt Managed Cloud is currently in beta. Some functionality may be subject to + change. + +Interested in joining the beta? [Request access here](https://flipt.cloud). + ## Prerequisites -Before you get started with Flipt Enterprise Cloud, you need to have the following: - -1. An active Flipt Enterprise Cloud account. If you don't have an account yet, [sign up here](https://flipt.cloud). -2. Enable the `cloud` [experimental feature](/configuration/experimental) in the Flipt configuration file. You can enable the `cloud` feature by adding the following configuration to your `flipt.yaml` file: +Before you move to production, you need to have the following: -```yaml -experimental: - cloud: - enabled: true -``` +1. An active Flipt Managed Cloud account. If you don't have an account yet, [request access here](https://flipt.cloud). +2. An active GitHub account. If you don't have an account yet, [sign up on GitHub](https://github.com). +3. A configured Flipt environment in Flipt Managed Cloud. If you don't have an environment yet, [follow the getting started guide](/cloud/guides/getting-started). +4. Deployed Flipt instances in your infrastructure. If you don't have Flipt instances yet, [deploy Flipt Open Source](https://docs.flipt.io/self-hosted/overview). - - Make sure you have the [latest - version](https://github.com/flipt-io/flipt/releases/latest) of the Flipt CLI - installed on your local machine. - - -## Create a New Environment - -To move your local Flipt instance to production, you need to create a new environment in Flipt Enterprise Cloud. This environment will be used to manage your feature flags and configurations in a production. +## Create an API Key - - First, log in to the Flipt Enterprise Cloud web interface. You can access the login page at [https://flipt.cloud](https://flipt.cloud). + + First, log in to the Flipt Managed Cloud web interface. You can access the login page at [https://flipt.cloud](https://flipt.cloud). - -Once you are logged in, you will see the Flipt Enterprise Cloud dashboard. Click on one of our suggested environments named either `Staging` or `Production`, or click on `Or something else` to create a custom environment. + -![Cloud Dashboard](/images/cloud/guides/production/dashboard.png) +From the Flipt Managed Cloud dashboard, find the environment you want to create an API key for and hover over the environment name. - -Give your environment a name and description to help you identify it later. + -![Name Environment](/images/cloud/guides/production/environment-form.png) +Click on the `Edit` link. + +![Edit Environment](/images/cloud/guides/production/edit-environment.png) - -Next, click on the `Download` button to download the configuration file for your instance. + -![Download Configuration](/images/cloud/guides/production/download-configuration.png) +Click on the `Security` tab and then click on the `Create API Key` button. -This configuration file contains the required settings for your instance to connect to your environment in Flipt Enterprise Cloud. +![Security](/images/cloud/guides/production/security.png) -Move the configuration file to your local [Flipt instance directory](/configuration/overview#configuration-file) + -```bash -mv ~/downloads/flipt.yaml /path/to/your/flipt/directory -``` + - +Give your API a name to help you identify it later and click on the `Create` button. - +![Name API Key](/images/cloud/guides/production/name-api-key.png) -Open the configuration file you downloaded in the previous step and update the `cloud` section with the API key you generated in the previous step for your instance. +Copy the API key to your clipboard and save it in a secure location. You will not be able to access the API key after you leave this page. -```yaml -cloud: - authentication: - api_key: "YOUR API KEY HERE" -``` +![API Key Created](/images/cloud/guides/production/api-key-created.png) - - -Start your Flipt instance with the updated configuration file. + -```bash -flipt -``` +## Configure a Client-Side SDK -or if you have a custom configuration file: +Currently, Flipt Managed Cloud only support client-side SDKs for direct evaluation via the Flipt Cloud API. -```bash -# if your configuration file is in a different location than the default -flipt -f /path/to/your/configuration.yaml -``` + + For more information on the architecture of Flipt Managed Cloud, see the + [architecture overview](/cloud/architecture). + + + + Chose the SDK that matches your application's language and install it. All Client-side SDKs are documented [here](/integration/client). - + + Configure the SDK with the API key you created in the previous step and set the following options: + - `URL`: The URL of the Flipt Cloud API. + - `Authentication`: The API key authentication method configured with the API key you created in the previous step. + - (Optional) `Namespace`: The namespace to use for the SDK. (Default: `default`) -After you've started your Flipt instance, go back to the Flipt Enterprise Cloud dashboard and you should see a successful connection message. + For example, here's how you can configure the SDK for a Go application: -![Environment Connected](/images/cloud/guides/production/environment-connected.png) + ```go + evaluationClient, _ := flipt.NewClient( + flipt.WithURL("https://-.flipt.cloud"), + flipt.WithClientTokenAuthentication(), + flipt.WithNamespace() + ) + ``` - + + That's it! πŸŽ‰ You can now use the SDK to evaluate feature flags and configurations. + + -Click on the `All done!` button to be taken back to the Flipt Enterprise Cloud dashboard. +## Scale and Configure Server-Side SDKs -![Dashboard Connected](/images/cloud/guides/production/dashboard-connected.png) +As mentioned in the [architecture overview](/cloud/architecture), Flipt Managed Cloud is designed to be used in conjunction with Flipt Open Source. This means that you can still use your existing Flipt instances and configurations while leveraging the security and user friendly features of Flipt Managed Cloud. -Click on the URL in the `Host` column to route to your instance. +Here's how you can configure your Flipt instances to use the Git repository data source and then use our server-side SDKs to evaluate feature flags within your infrastructure. -![Flipt](/images/cloud/guides/production/flipt.png) + + + Configure the Flipt instances to use the Git repository data source. + + As described in the Flipt Open Source [storage documentation](/configuration/storage#git), you can configure the Flipt instances to use the Git repository data source. -You are automatically authenticated with your Flipt Enterprise Cloud account and can start managing your feature flags and configurations in your production environment. + Here you can use the same repository and branch as you used when creating the Flipt Managed Cloud environment. + + ```yaml + storage: + type: git + git: + repository: "https://github.com//" + ref: "main" + poll_interval: "30s" + authentication: + token: + access_token: + ``` - - The address provided in the Flipt Enterprise Cloud dashboard is a permanent route to your instance. You can access your instance through this address at any time. - - -## What Just Happened? +{" "} -You have successfully and permanently connected your Flipt instance to Flipt Enterprise Cloud! πŸŽ‰ + + Restart the Flipt instances to apply the changes. + - - Note that you didn't have to mess with DNS or firewall settings to enable the - connection between Flipt and your instance. Flipt Enterprise Cloud takes care - of all the networking for you. - + + Chose the SDK that matches your application's language and install it. All Server-side SDKs are documented [here](/integration/server). -### Details + + You can also use any of our [OpenFeature SDKs](/integration/openfeature) or [OpenFeature Remote Evaluation Protocol implementations](/integration/openfeature#remote-evaluation-protocol) to evaluate feature flags within your infrastructure. + -- You now have a fully functional Flipt instance running in your infrastructure that's protected behind authentication provided by Flipt Enterprise Cloud. πŸ”’ + -- You can now access this instance through the Flipt Enterprise Cloud web interface from anywhere in the world! 🌍 + + Configure the SDK with the URL of your Flipt instance within your infrastructure. + - `URL`: The URL of the Flipt instance. -- Only users in your organization with the appropriate permissions can access your instance through Flipt Enterprise Cloud. πŸ›‘οΈ + For example, here's how you can configure the OpenFeature SDK for a Go application: -The address provided in the Flipt Enterprise Cloud dashboard is a permanent route to your instance. You can access your instance through this address at any time and it will not expire. + ```go + provider := flipt.NewProvider(flipt.WithAddress("https://localhost:443")) // Replace with the URL of your Flipt instance + openfeature.SetProvider(provider) - - The connection is valid as long as your API Key stays the same. - - If you need to regenerate your API Key, you can generate a new one by clicking on the environment in the Flipt Enterprise Cloud dashboard and clicking on the `Configuration` tab. + client := openfeature.NewClient("my-app") + value, err := client.BooleanValue(context.Background(), "v2_enabled", false, openfeature.NewEvaluationContext( + "tim@apple.com", + map[string]interface{}{ + "favorite_color": "blue", + }, + )) + ``` - + + + That's it! πŸŽ‰ You can now scale your feature flagging operations with Flipt Managed Cloud and Flipt Open Source. + + All changes to the feature flags and configurations are automatically propagated to your Flipt instances within your infrastructure through the Git repository data source. + + + ## What's Next? -Now that you have successfully connected your permanent instance to Flipt Enterprise Cloud, you can start creating feature flags and managing your feature flag configurations. +You can now start using Flipt Managed Cloud to scale your feature flagging operations. + +As your organization grows, check out some of our enterprise features including: + +- [Single Sign-On](/cloud/features/authentication#single-sign-on) +- [Role Based Access Control](/cloud/features/rbac) +- [User Management](/cloud/features/user-management) + +## Questions? -You can now learn more about the advanced features and capabilities available to you such as [Single Sign-On](/cloud/features/authentication), [Role-Based Access Control](/cloud/features/rbac), and [Audit Logs](/cloud/features/audit-logs). +If you have any questions or need further assistance, please ask in either our [Discord channel](https://flipt.io/discord) or [Flipt Community Discourse](https://community.flipt.io/c/flipt-cloud/6). diff --git a/cloud/overview.mdx b/cloud/overview.mdx index b859a153..e9b4d78a 100644 --- a/cloud/overview.mdx +++ b/cloud/overview.mdx @@ -1,20 +1,26 @@ --- title: Introduction -description: Our Enterprise Cloud offering is the simplest, scalable solution for running Flipt open-source on your infrastructure +description: Our Managed Cloud offering is the simplest, scalable solution for getting started with Flipt without the need to manage your own infrastructure. --- - Flipt Enterprise Cloud is currently in beta. Visit our - [website](https://flipt.io/cloud) to learn more and sign up today! + Flipt Managed Cloud is currently in beta. Some functionality may be subject to change. + +Interested in joining the beta? [Request access here](https://flipt.cloud). + - - - +**Introducing Flipt Managed Cloud: Powerful Feature Management Without the Operational Overhead** + +- **Fully Managed, Git-Backed Solution**: Experience the power of Flipt without the hassle of infrastructure management. Our fully hosted solution runs Flipt for you, backed by Git for version control and data sovereignty. -**Introducing Flipt Enterprise Cloud: A Seamless Blend of Flexibility and Control** +- **GitOps and ClickOps Friendly**: Store your feature flag configurations in your own Git repository, giving you full control over your data while benefiting from familiar Git workflows. Non-technical team members can still easily manage flags through our user-friendly interface. -- **Familiar Deployment, Enhanced Capabilities**: Deploy the open-source Flipt on your infrastructure as you always have, but with added robustness. Experience a seamless transition with enhanced features that fit perfectly into your existing setup. +- **Zero Lock-In**: With your feature flag data stored in a standard Git format, you're never locked into our platform. Easily export or migrate your data at any time, ensuring flexibility as your needs evolve. + +- **Scalable and Enterprise-Ready**: Our cloud infrastructure is designed to handle high-volume traffic and complex flag evaluations, making it suitable for organizations of all sizes, from startups to global enterprises. + +- **Cost-Effective and Predictable Pricing**: Enjoy a simple, predictable pricing model based on the features you need, not on the number of flags or evaluations. This allows for better budget planning and eliminates unexpected costs as your usage grows. - **Ready from the Start**: Jump right in with Flipt’s intuitive management user interface, available from day one. This immediate readiness ensures a smooth, hassle-free start to your feature flag management journey. @@ -23,5 +29,3 @@ description: Our Enterprise Cloud offering is the simplest, scalable solution fo - **Simple Self-Service Setup for Integrations**: Enjoy a straightforward, self-service setup for Single Sign-On (SSO) and other integrations. This user-friendly approach reduces complexity and enhances your operational efficiency. - **Directory Sync\***: Coming soon! Sync your user directory with Flipt, ensuring that your team members have the right access and permissions. Microsoft Active Directory, Okta, Workday, and Google Workspace supported out of the box. - -- **Future-Proof Your Operations with Advanced Features**: Stay ahead with plans for in-application metrics, insights, and managed storage. Our upcoming features are designed to provide deep insights and enhanced control, helping you make data-driven decisions with ease. diff --git a/configuration/authentication.mdx b/configuration/authentication.mdx index 8920baef..bf6aa660 100644 --- a/configuration/authentication.mdx +++ b/configuration/authentication.mdx @@ -298,7 +298,7 @@ authentication: - user:email ``` -!["GitHub Login"](../images/guides/operation/authentication/login-with-github/login-with-github.png) +!["GitHub Login"](images/guides/login-with-github/login-with-github.png) #### Allowed Organizations diff --git a/configuration/experimental.mdx b/configuration/experimental.mdx index 3ec2cafe..92fe1b8c 100644 --- a/configuration/experimental.mdx +++ b/configuration/experimental.mdx @@ -21,9 +21,9 @@ experimental: You can also enable experimental features using [environment - variables](/overview#environment-variables). For example, to enable the `foo` - experimental feature, you can set the `FLIPT_EXPERIMENTAL_FOO_ENABLED` - environment variable to `true`. + variables](/configuration/overview#environment-variables). For example, to + enable the `foo` experimental feature, you can set the + `FLIPT_EXPERIMENTAL_FOO_ENABLED` environment variable to `true`. ## Current Experimental Features @@ -36,32 +36,6 @@ The following is a list of our current experimental features and a brief descrip installed on your local machine. -### Cloud - -Introduced in `v1.42.0`. - -[Flipt Enterprise Cloud](cloud/overview) enables you to continue to use Flipt's feature management capabilities while keeping your feature data on-premises but still benefiting from our cloud-based management console. - -With Flipt Enterprise Cloud you get the following benefits: - -- [Managed Authentication](/cloud/features/authentication): Securely authenticate your users with Flipt's managed authentication service, which supports email/password, magic link, social login, and SSO with popular providers. -- [User Management](/cloud/features/user-management): Manage your users and teams with Flipt's user management service, which supports roles, permissions, and role-based access control. -- [Hosted Audit Logs](/cloud/features/audit-logs): Keep track of changes to your feature data with Flipt's hosted audit logs service, which provides a detailed history of all changes made to your feature data with 30 days of retention by default (custom retention periods are available). - -To enable the Flipt Enterprise Cloud experimental feature, set the `experimental.cloud.enabled` configuration option to `true`. - -```yaml config.yaml -experimental: - cloud: - enabled: true -``` - - - You must have a valid Flipt Enterprise Cloud account to use this feature. To - learn more about Flipt Enterprise Cloud, visit our - [website](https://flipt.io/cloud) and sign up for an account. - - ## Deprecations Once an experimental feature is promoted to a stable feature or is removed, it will move to a deprecated status. Depending on the feature, you may need to take action to migrate to the new stable feature or remove the deprecated feature from your configuration. diff --git a/configuration/overview.mdx b/configuration/overview.mdx index cf42e491..3f6f412e 100644 --- a/configuration/overview.mdx +++ b/configuration/overview.mdx @@ -96,7 +96,7 @@ Environment variables **MUST** have `FLIPT_` prefix and be in `UPPER_SNAKE_CASE` Using environment variables to override defaults is especially helpful when - running with Docker as described in the [Installation](/installation) + running with Docker as described in the [Docker](/self-hosted/docker) documentation. diff --git a/configuration/storage.mdx b/configuration/storage.mdx index acd65a10..b64b8cb8 100644 --- a/configuration/storage.mdx +++ b/configuration/storage.mdx @@ -277,7 +277,7 @@ storage: do `ssh-keyscan github.com >> ~/.ssh/known_hosts` on the Flipt host. -See our [GitOps Guide](/guides/get-going-with-gitops) for an example of how to set up a GitHub repository as a flag state backend. +See our [GitOps Guide](/guides/user/get-going-with-gitops) for an example of how to set up a GitHub repository as a flag state backend. #### Repository Storage diff --git a/guides/migration/launchdarkly/flipt.mdx b/guides/migration/launchdarkly/flipt.mdx index 7563ea6d..418d8a29 100644 --- a/guides/migration/launchdarkly/flipt.mdx +++ b/guides/migration/launchdarkly/flipt.mdx @@ -61,7 +61,6 @@ Generally speaking, it’s preferable to open up new flags individually when mig If you need assistance with migrating your flags from LaunchDarkly to Flipt, join our [Discord community](https://flipt.io/discord) and ask for help in the #migration channel. - Flipt offers flag state migration services for any paid user of our - [Enterprise Cloud](/cloud/overview) offering. We’re working on extending this - offer to the rest of the ecosystem as well! + Flipt offers flag state migration services for any paid user of our [Managed + Cloud](/cloud/overview) offering. diff --git a/guides/migration/launchdarkly/overview.mdx b/guides/migration/launchdarkly/overview.mdx index 9bc52fa2..587df456 100644 --- a/guides/migration/launchdarkly/overview.mdx +++ b/guides/migration/launchdarkly/overview.mdx @@ -24,9 +24,8 @@ the LaunchDarkly OpenFeature provider to the Flipt OpenFeature provider. In order to use Flipt, you would need to install it in your infrastructure. -If you want us to handle security and user management for you, you can -leverage our [Enterprise Cloud](/cloud/overview) offering in addition to installing your Flipt -instance. +If you want us to handle the running and maintenance of Flipt, you can +leverage our [Managed Cloud](/cloud/overview) offering. 4. [**Migrate State from LaunchDarkly to Flipt**](/guides/migration/launchdarkly/flipt#migrate-state-from-launchdarkly-to-flipt) @@ -34,8 +33,8 @@ The last part is to migrate all of your existing flags from the LaunchDarkly interface to your Flipt instance. - Flipt has a new [Enterprise Cloud](/cloud/overview) offering that allows you - to run your own Flipt instance, without worrying about managing authentication - and users. It has no limits - and we'll assist you in LaunchDarkly to Flipt - migration services for free, for all of our paying users. + Flipt has a new [Managed Cloud](/cloud/overview) offering that allows you to + scale your feature management platform without worrying about the underlying + infrastructure. We'll assist you in LaunchDarkly to Flipt migration services + for free, for all of our paying users. diff --git a/guides/user/using-references.mdx b/guides/user/using-references.mdx index fb27d972..0cee6f71 100644 --- a/guides/user/using-references.mdx +++ b/guides/user/using-references.mdx @@ -39,7 +39,7 @@ We also make use of Flipt's GitOps integration to manage our feature flags in ou If you're not familiar with Flipt's GitOps integration, check out our{" "} - GitOps guide for more + GitOps guide for more information. diff --git a/images/cloud/architecture/architecture-overview-dark.svg b/images/cloud/architecture/architecture-overview-dark.svg deleted file mode 100644 index a53c6fce..00000000 --- a/images/cloud/architecture/architecture-overview-dark.svg +++ /dev/null @@ -1,190 +0,0 @@ -internetYour InfrastructureQUICGatewayFlipt CloudReverst flipt.cloudenvironment-org.flipt.cloudflipt.cloudenvironment-org.flipt.cloud - - - - - - - - - - - - diff --git a/images/cloud/architecture/architecture-overview-light.svg b/images/cloud/architecture/architecture-overview-light.svg deleted file mode 100644 index fe6867e7..00000000 --- a/images/cloud/architecture/architecture-overview-light.svg +++ /dev/null @@ -1 +0,0 @@ -internetYour InfrastructureQUICGatewayFlipt CloudReverstflipt.cloudenvironment-org.flipt.cloudflipt.cloudenvironment-org.flipt.cloud \ No newline at end of file diff --git a/images/cloud/architecture/architecture-overview.d2 b/images/cloud/architecture/architecture-overview.d2 deleted file mode 100644 index ee3b0067..00000000 --- a/images/cloud/architecture/architecture-overview.d2 +++ /dev/null @@ -1,82 +0,0 @@ -vars: { - d2-config: { - layout-engine: elk - } -} - -style: { - fill: transparent -} - -direction: right - -internet: { - shape: image - icon: https://icons.terrastruct.com/essentials%2F140-internet.svg -} - -internet -> cloud.gateway: flipt.cloud { - style.font-size: 32 -} -internet -> cloud.gateway: environment-org.flipt.cloud { - style.font-size: 32 -} - -cloud: "" { - style: { - fill: transparent - } - - gateway: Gateway { - shape: image - icon: https://icons.terrastruct.com/infra%2F033-protection.svg - style.font-size: 32 - } - - cloudInstance: Flipt Cloud { - shape: image - icon: https://flipt.cloud/icon.svg?3c7bba14eb804cba - style.font-size: 32 - } - gateway -> cloudInstance: flipt.cloud { - style.font-size: 32 - } - - reverst: Reverst { - shape: image - icon: https://icons.terrastruct.com/infra%2F012-data.svg - style.font-size: 32 - } - gateway -> reverst: environment-org.flipt.cloud { - style.font-size: 32 - } -} - -yours: Your Infrastructure { - style.fill: transparent - fapi: "" { - icon: https://assets-global.website-files.com/659480aa07716c37f0fd8dee/6597f2baa456ff33c9f13a07_logo%201.svg - } - - ftwo: "" { - icon: https://assets-global.website-files.com/659480aa07716c37f0fd8dee/6597f2baa456ff33c9f13a07_logo%201.svg - } - - fthree: "" { - icon: https://assets-global.website-files.com/659480aa07716c37f0fd8dee/6597f2baa456ff33c9f13a07_logo%201.svg - } -} - -cloud.reverst <-> quic -cloud.reverst <-> quic -cloud.reverst <-> quic - -quic: "QUIC" { - shape: image - icon: https://raw.githubusercontent.com/quicwg/wg-materials/main/badge/transparent/QUIC-Badge-Dark-RGB.svg - style.font-size: 32 -} - -quic <-> yours.fapi -quic <-> yours.ftwo -quic <-> yours.fthree diff --git a/images/cloud/architecture/client-evaluation-cloud-dark.svg b/images/cloud/architecture/client-evaluation-cloud-dark.svg new file mode 100644 index 00000000..a28f4721 --- /dev/null +++ b/images/cloud/architecture/client-evaluation-cloud-dark.svg @@ -0,0 +1,185 @@ +Your InfrastructureClient-Side SDKsFlipt CloudEnvironments environment-org.flipt.cloud + + + + + + + diff --git a/images/cloud/architecture/client-evaluation-cloud-light.svg b/images/cloud/architecture/client-evaluation-cloud-light.svg new file mode 100644 index 00000000..950a9436 --- /dev/null +++ b/images/cloud/architecture/client-evaluation-cloud-light.svg @@ -0,0 +1,113 @@ +Your InfrastructureClient-Side SDKsFlipt CloudEnvironments environment-org.flipt.cloud + + + + + + + diff --git a/images/cloud/architecture/client-evaluation-cloud.d2 b/images/cloud/architecture/client-evaluation-cloud.d2 new file mode 100644 index 00000000..44cc3da8 --- /dev/null +++ b/images/cloud/architecture/client-evaluation-cloud.d2 @@ -0,0 +1,72 @@ +vars: { + d2-config: { + layout-engine: elk + } +} + +style: { + fill: transparent +} + +direction: right + +infrastructure: "Your Infrastructure" { + style: { + fill: transparent + } + + clients: "Client-Side SDKs" { + style: { + fill: transparent + stroke: "#000000" + stroke-dash: 3 + } + + typescript: "" { + shape: image + icon: https://icons.terrastruct.com/dev%2Ftypescript.svg + style.font-size: 32 + } + + go: "" { + shape: image + icon: https://icons.terrastruct.com/dev%2Fgo.svg + style.font-size: 32 + } + + java: "" { + shape: image + icon: https://icons.terrastruct.com/dev%2Fjava.svg + style.font-size: 32 + } + } +} + + +cloud: "" { + style: { + fill: transparent + } + + cloudInstance: Flipt Cloud { + shape: image + icon: https://flipt.cloud/icon.svg?3c7bba14eb804cba + style.font-size: 32 + } + + environments: Environments { + style: { + fill: transparent + stroke: "#000000" + stroke-dash: 3 + } + + fone: "" { + icon: https://assets-global.website-files.com/659480aa07716c37f0fd8dee/6597f2baa456ff33c9f13a07_logo%201.svg + } + } +} + +infrastructure.clients.typescript <-> cloud.environments.fone +infrastructure.clients.go <-> cloud.environments.fone: environment-org.flipt.cloud +infrastructure.clients.java <-> cloud.environments.fone \ No newline at end of file diff --git a/images/cloud/architecture/client-evaluation-self-hosted-dark.svg b/images/cloud/architecture/client-evaluation-self-hosted-dark.svg new file mode 100644 index 00000000..2abbac9b --- /dev/null +++ b/images/cloud/architecture/client-evaluation-self-hosted-dark.svg @@ -0,0 +1,179 @@ +Your InfrastructureGitHubFlipt CloudEnvironmentsFlipt InstanceClient-Side SDKs + + + + + + + + diff --git a/images/cloud/architecture/client-evaluation-self-hosted-light.svg b/images/cloud/architecture/client-evaluation-self-hosted-light.svg new file mode 100644 index 00000000..90fdd321 --- /dev/null +++ b/images/cloud/architecture/client-evaluation-self-hosted-light.svg @@ -0,0 +1,107 @@ +Your InfrastructureGitHubFlipt CloudEnvironmentsFlipt InstanceClient-Side SDKs + + + + + + + + diff --git a/images/cloud/architecture/client-evaluation-self-hosted.d2 b/images/cloud/architecture/client-evaluation-self-hosted.d2 new file mode 100644 index 00000000..dd2b54ea --- /dev/null +++ b/images/cloud/architecture/client-evaluation-self-hosted.d2 @@ -0,0 +1,85 @@ +vars: { + d2-config: { + layout-engine: elk + } +} + +style: { + fill: transparent +} + +direction: left + +cloud: "" { + style: { + fill: transparent + } + + cloudInstance: Flipt Cloud { + shape: image + icon: https://flipt.cloud/icon.svg?3c7bba14eb804cba + style.font-size: 32 + } + + environments: Environments { + style: { + fill: transparent + stroke: "#000000" + stroke-dash: 3 + } + + fone: "" { + icon: https://assets-global.website-files.com/659480aa07716c37f0fd8dee/6597f2baa456ff33c9f13a07_logo%201.svg + } + } +} + +infrastructure: "Your Infrastructure" { + style: { + fill: transparent + } + + flipt-instance: "Flipt Instance" { + shape: image + icon: https://assets-global.website-files.com/659480aa07716c37f0fd8dee/6597f2baa456ff33c9f13a07_logo%201.svg + style.font-size: 32 + } + + clients: "Client-Side SDKs" { + style: { + fill: transparent + stroke: "#000000" + stroke-dash: 3 + } + + typescript: "" { + shape: image + icon: https://icons.terrastruct.com/dev%2Ftypescript.svg + style.font-size: 32 + } + + go: "" { + shape: image + icon: https://icons.terrastruct.com/dev%2Fgo.svg + style.font-size: 32 + } + + java: "" { + shape: image + icon: https://icons.terrastruct.com/dev%2Fjava.svg + style.font-size: 32 + } + } +} + +github: "GitHub" { + shape: image + icon: https://icons.terrastruct.com/dev%2Fgithub.svg + style.font-size: 32 +} + +cloud.environments.fone <-> github +github <-> infrastructure.flipt-instance +infrastructure.clients.typescript <-> infrastructure.flipt-instance +infrastructure.clients.go <-> infrastructure.flipt-instance +infrastructure.clients.java <-> infrastructure.flipt-instance \ No newline at end of file diff --git a/images/cloud/architecture/common-infrastructure-dark.svg b/images/cloud/architecture/common-infrastructure-dark.svg deleted file mode 100644 index eec881be..00000000 --- a/images/cloud/architecture/common-infrastructure-dark.svg +++ /dev/null @@ -1,179 +0,0 @@ -internetYour InfrastructureDNS ZoneLoad BalancerTLS CredentialsDatabase - - - - - - - - diff --git a/images/cloud/architecture/common-infrastructure-light.svg b/images/cloud/architecture/common-infrastructure-light.svg deleted file mode 100644 index 6b177767..00000000 --- a/images/cloud/architecture/common-infrastructure-light.svg +++ /dev/null @@ -1,107 +0,0 @@ -internetYour InfrastructureDNS ZoneLoad BalancerTLS CredentialsDatabase - - - - - - - - diff --git a/images/cloud/architecture/common-infrastructure.d2 b/images/cloud/architecture/common-infrastructure.d2 deleted file mode 100644 index adaede90..00000000 --- a/images/cloud/architecture/common-infrastructure.d2 +++ /dev/null @@ -1,68 +0,0 @@ -vars: { - d2-config: { - layout-engine: elk - } -} - -direction: right - -style.fill: transparent - -internet: { - shape: image - icon: https://icons.terrastruct.com/essentials%2F140-internet.svg -} - -internet -> user.zone.elb - -user: Your Infrastructure { - style: { - stroke: transparent - fill: transparent - } - - zone: DNS Zone { - icon: https://icons.terrastruct.com/aws%2FNetworking%20&%20Content%20Delivery%2FAmazon-Route-53_Hosted-Zone_light-bg.svg - - style: { - fill: transparent - } - - elb: Load Balancer { - shape: image - icon: https://icons.terrastruct.com/aws%2FNetworking%20&%20Content%20Delivery%2FElastic-Load-Balancing-ELB_Network-load-balancer_light-bg.svg - } - - keys: TLS Credentials { - shape: image - icon: https://icons.terrastruct.com/essentials%2F216-key.svg - } - - elb -> keys - - fapi: "" { - icon: https://assets-global.website-files.com/659480aa07716c37f0fd8dee/6597f2baa456ff33c9f13a07_logo%201.svg - } - - ftwo: "" { - icon: https://assets-global.website-files.com/659480aa07716c37f0fd8dee/6597f2baa456ff33c9f13a07_logo%201.svg - } - - fthree: "" { - icon: https://assets-global.website-files.com/659480aa07716c37f0fd8dee/6597f2baa456ff33c9f13a07_logo%201.svg - } - - elb -> fapi - elb -> ftwo - elb -> fthree - - db: Database { - shape: image - icon: https://icons.terrastruct.com/essentials%2F117-database.svg - } - - fapi -> db - ftwo -> db - fthree -> db - } -} diff --git a/images/cloud/architecture/handshake-dark.svg b/images/cloud/architecture/handshake-dark.svg deleted file mode 100644 index fc7e147d..00000000 --- a/images/cloud/architecture/handshake-dark.svg +++ /dev/null @@ -1,185 +0,0 @@ -FliptFlipt CloudFlipt UserFlipt registers on flipt.cloudInstance served on flipt.cloudTunnelled request Register TunnelRegisteredenvironment-org.flipt.cloudRequestResponseResponse - - - - - - - - - - - - - - diff --git a/images/cloud/architecture/handshake-light.svg b/images/cloud/architecture/handshake-light.svg deleted file mode 100644 index 0f36855b..00000000 --- a/images/cloud/architecture/handshake-light.svg +++ /dev/null @@ -1 +0,0 @@ -FliptFlipt CloudFlipt UserFlipt registers on flipt.cloudInstance served on flipt.cloudTunnelled requestRegister TunnelRegisteredenvironment-org.flipt.cloudRequestResponseResponse \ No newline at end of file diff --git a/images/cloud/architecture/handshake.d2 b/images/cloud/architecture/handshake.d2 deleted file mode 100644 index aa2ef63c..00000000 --- a/images/cloud/architecture/handshake.d2 +++ /dev/null @@ -1,22 +0,0 @@ -shape: sequence_diagram - -style.fill: transparent - -client_one: Flipt -tunnel: Flipt Cloud - -register: Flipt registers on flipt.cloud { - client_one -> tunnel.handshake: Register Tunnel - tunnel.handshake -> client_one: Registered -} - -user: Flipt User - -environment: Instance served on flipt.cloud { - user -> tunnel.req: environment-org.flipt.cloud - Tunnelled request: { - tunnel -> client_one.req: Request - client_one.req -> tunnel: Response - } - tunnel.req -> user: Response -} diff --git a/images/cloud/architecture/overview-dark.svg b/images/cloud/architecture/overview-dark.svg new file mode 100644 index 00000000..b24d5407 --- /dev/null +++ b/images/cloud/architecture/overview-dark.svg @@ -0,0 +1,186 @@ +internetGitHubFlipt CloudEnvironments flipt.cloudenvironment-org.flipt.cloud + + + + + + + + diff --git a/images/cloud/architecture/overview-light.svg b/images/cloud/architecture/overview-light.svg new file mode 100644 index 00000000..6434ab45 --- /dev/null +++ b/images/cloud/architecture/overview-light.svg @@ -0,0 +1,114 @@ +internetGitHubFlipt CloudEnvironments flipt.cloudenvironment-org.flipt.cloud + + + + + + + + diff --git a/images/cloud/architecture/overview.d2 b/images/cloud/architecture/overview.d2 new file mode 100644 index 00000000..84490595 --- /dev/null +++ b/images/cloud/architecture/overview.d2 @@ -0,0 +1,65 @@ +vars: { + d2-config: { + layout-engine: elk + } +} + +style: { + fill: transparent +} + +direction: right + +internet: { + shape: image + icon: https://icons.terrastruct.com/essentials%2F140-internet.svg +} + +internet -> cloud.cloudInstance: flipt.cloud { + style.font-size: 32 +} +internet -> cloud.environments.fone: environment-org.flipt.cloud { + style.font-size: 32 +} + +cloud: "" { + style: { + fill: transparent + } + + cloudInstance: Flipt Cloud { + shape: image + icon: https://flipt.cloud/icon.svg?3c7bba14eb804cba + style.font-size: 32 + } + + environments: Environments { + style: { + fill: transparent + stroke: "#000000" + stroke-dash: 3 + } + + fone: "" { + icon: https://assets-global.website-files.com/659480aa07716c37f0fd8dee/6597f2baa456ff33c9f13a07_logo%201.svg + } + + ftwo: "" { + icon: https://assets-global.website-files.com/659480aa07716c37f0fd8dee/6597f2baa456ff33c9f13a07_logo%201.svg + } + + fthree: "" { + icon: https://assets-global.website-files.com/659480aa07716c37f0fd8dee/6597f2baa456ff33c9f13a07_logo%201.svg + } + } +} + +github: "GitHub" { + shape: image + icon: https://icons.terrastruct.com/dev%2Fgithub.svg + style.font-size: 32 +} + +cloud.environments.fone <-> github +cloud.environments.ftwo <-> github +cloud.environments.fthree <-> github \ No newline at end of file diff --git a/images/cloud/architecture/server-evaluation-self-hosted-dark.svg b/images/cloud/architecture/server-evaluation-self-hosted-dark.svg new file mode 100644 index 00000000..214f9260 --- /dev/null +++ b/images/cloud/architecture/server-evaluation-self-hosted-dark.svg @@ -0,0 +1,179 @@ +Your InfrastructureGitHubFlipt CloudEnvironmentsFlipt InstanceServer-Side SDKs + + + + + + + + diff --git a/images/cloud/architecture/server-evaluation-self-hosted-light.svg b/images/cloud/architecture/server-evaluation-self-hosted-light.svg new file mode 100644 index 00000000..de52e374 --- /dev/null +++ b/images/cloud/architecture/server-evaluation-self-hosted-light.svg @@ -0,0 +1,107 @@ +Your InfrastructureGitHubFlipt CloudEnvironmentsFlipt InstanceServer-Side SDKs + + + + + + + + diff --git a/images/cloud/architecture/server-evaluation-self-hosted.d2 b/images/cloud/architecture/server-evaluation-self-hosted.d2 new file mode 100644 index 00000000..fa2b897b --- /dev/null +++ b/images/cloud/architecture/server-evaluation-self-hosted.d2 @@ -0,0 +1,85 @@ +vars: { + d2-config: { + layout-engine: elk + } +} + +style: { + fill: transparent +} + +direction: left + +cloud: "" { + style: { + fill: transparent + } + + cloudInstance: Flipt Cloud { + shape: image + icon: https://flipt.cloud/icon.svg?3c7bba14eb804cba + style.font-size: 32 + } + + environments: Environments { + style: { + fill: transparent + stroke: "#000000" + stroke-dash: 3 + } + + fone: "" { + icon: https://assets-global.website-files.com/659480aa07716c37f0fd8dee/6597f2baa456ff33c9f13a07_logo%201.svg + } + } +} + +infrastructure: "Your Infrastructure" { + style: { + fill: transparent + } + + flipt-instance: "Flipt Instance" { + shape: image + icon: https://assets-global.website-files.com/659480aa07716c37f0fd8dee/6597f2baa456ff33c9f13a07_logo%201.svg + style.font-size: 32 + } + + clients: "Server-Side SDKs" { + style: { + fill: transparent + stroke: "#000000" + stroke-dash: 3 + } + + openfeature: "" { + shape: image + icon: https://openfeature.dev/img/logo-dark.svg + style.font-size: 32 + } + + go: "" { + shape: image + icon: https://icons.terrastruct.com/dev%2Fgo.svg + style.font-size: 32 + } + + rust: "" { + shape: image + icon: https://icons.terrastruct.com/dev%2Frust.svg + style.font-size: 32 + } + } +} + +github: "GitHub" { + shape: image + icon: https://icons.terrastruct.com/dev%2Fgithub.svg + style.font-size: 32 +} + +cloud.environments.fone <-> github +github <-> infrastructure.flipt-instance +infrastructure.clients.openfeature <-> infrastructure.flipt-instance +infrastructure.clients.go <-> infrastructure.flipt-instance +infrastructure.clients.rust <-> infrastructure.flipt-instance \ No newline at end of file diff --git a/images/cloud/features/audit-event.png b/images/cloud/features/audit-event.png deleted file mode 100644 index c278ed78..00000000 Binary files a/images/cloud/features/audit-event.png and /dev/null differ diff --git a/images/cloud/features/audit-list.png b/images/cloud/features/audit-list.png deleted file mode 100644 index 8604fd51..00000000 Binary files a/images/cloud/features/audit-list.png and /dev/null differ diff --git a/images/cloud/features/auth/api-access.png b/images/cloud/features/auth/api-access.png new file mode 100644 index 00000000..0d404719 Binary files /dev/null and b/images/cloud/features/auth/api-access.png differ diff --git a/images/cloud/features/auth/api-key.png b/images/cloud/features/auth/api-key.png new file mode 100644 index 00000000..8abdcbf0 Binary files /dev/null and b/images/cloud/features/auth/api-key.png differ diff --git a/images/cloud/features/auth/login.png b/images/cloud/features/auth/login.png new file mode 100644 index 00000000..ff3e4dad Binary files /dev/null and b/images/cloud/features/auth/login.png differ diff --git a/images/cloud/features/auth/sso.gif b/images/cloud/features/auth/sso.gif new file mode 100644 index 00000000..58f55c52 Binary files /dev/null and b/images/cloud/features/auth/sso.gif differ diff --git a/images/cloud/features/git/feature-flag-in-repository.png b/images/cloud/features/git/feature-flag-in-repository.png new file mode 100644 index 00000000..6a81572c Binary files /dev/null and b/images/cloud/features/git/feature-flag-in-repository.png differ diff --git a/images/cloud/features/git/feature-flag-in-ui.png b/images/cloud/features/git/feature-flag-in-ui.png new file mode 100644 index 00000000..ae682ba6 Binary files /dev/null and b/images/cloud/features/git/feature-flag-in-ui.png differ diff --git a/images/cloud/features/invite.png b/images/cloud/features/invite.png deleted file mode 100644 index 9fac08b7..00000000 Binary files a/images/cloud/features/invite.png and /dev/null differ diff --git a/images/cloud/features/login.png b/images/cloud/features/login.png deleted file mode 100644 index ebb10a7f..00000000 Binary files a/images/cloud/features/login.png and /dev/null differ diff --git a/images/cloud/features/rbac/roles-assign.png b/images/cloud/features/rbac/roles-assign.png new file mode 100644 index 00000000..d9e8ff84 Binary files /dev/null and b/images/cloud/features/rbac/roles-assign.png differ diff --git a/images/cloud/features/rbac/roles-built-in.png b/images/cloud/features/rbac/roles-built-in.png new file mode 100644 index 00000000..634b04ec Binary files /dev/null and b/images/cloud/features/rbac/roles-built-in.png differ diff --git a/images/cloud/features/rbac/roles-custom.png b/images/cloud/features/rbac/roles-custom.png new file mode 100644 index 00000000..31263df9 Binary files /dev/null and b/images/cloud/features/rbac/roles-custom.png differ diff --git a/images/cloud/features/rbac/roles.png b/images/cloud/features/rbac/roles.png new file mode 100644 index 00000000..a393a2e2 Binary files /dev/null and b/images/cloud/features/rbac/roles.png differ diff --git a/images/cloud/features/roles-assign.png b/images/cloud/features/roles-assign.png deleted file mode 100644 index 3597aea4..00000000 Binary files a/images/cloud/features/roles-assign.png and /dev/null differ diff --git a/images/cloud/features/roles-built-in.png b/images/cloud/features/roles-built-in.png deleted file mode 100644 index 51aa94c8..00000000 Binary files a/images/cloud/features/roles-built-in.png and /dev/null differ diff --git a/images/cloud/features/roles-custom.png b/images/cloud/features/roles-custom.png deleted file mode 100644 index 6d2ba4e8..00000000 Binary files a/images/cloud/features/roles-custom.png and /dev/null differ diff --git a/images/cloud/features/roles.png b/images/cloud/features/roles.png deleted file mode 100644 index 04ed93d5..00000000 Binary files a/images/cloud/features/roles.png and /dev/null differ diff --git a/images/cloud/features/sso.png b/images/cloud/features/sso.png deleted file mode 100644 index 55e6ba3e..00000000 Binary files a/images/cloud/features/sso.png and /dev/null differ diff --git a/images/cloud/features/team.png b/images/cloud/features/team.png deleted file mode 100644 index 64db06c5..00000000 Binary files a/images/cloud/features/team.png and /dev/null differ diff --git a/images/cloud/features/users/invite.png b/images/cloud/features/users/invite.png new file mode 100644 index 00000000..73895ea5 Binary files /dev/null and b/images/cloud/features/users/invite.png differ diff --git a/images/cloud/features/users/team.png b/images/cloud/features/users/team.png new file mode 100644 index 00000000..00a8180d Binary files /dev/null and b/images/cloud/features/users/team.png differ diff --git a/images/cloud/guides/getting-started/authorize-github.png b/images/cloud/guides/getting-started/authorize-github.png new file mode 100644 index 00000000..14a1be5a Binary files /dev/null and b/images/cloud/guides/getting-started/authorize-github.png differ diff --git a/images/cloud/guides/getting-started/choose-path.png b/images/cloud/guides/getting-started/choose-path.png new file mode 100644 index 00000000..e42dc9be Binary files /dev/null and b/images/cloud/guides/getting-started/choose-path.png differ diff --git a/images/cloud/guides/getting-started/create-flag.png b/images/cloud/guides/getting-started/create-flag.png new file mode 100644 index 00000000..1899c5c9 Binary files /dev/null and b/images/cloud/guides/getting-started/create-flag.png differ diff --git a/images/cloud/guides/getting-started/dashboard.png b/images/cloud/guides/getting-started/dashboard.png index e5b47896..b93b39fb 100644 Binary files a/images/cloud/guides/getting-started/dashboard.png and b/images/cloud/guides/getting-started/dashboard.png differ diff --git a/images/cloud/guides/getting-started/done.png b/images/cloud/guides/getting-started/done.png new file mode 100644 index 00000000..f0cd03bc Binary files /dev/null and b/images/cloud/guides/getting-started/done.png differ diff --git a/images/cloud/guides/getting-started/environment-form.png b/images/cloud/guides/getting-started/environment-form.png new file mode 100644 index 00000000..db24c038 Binary files /dev/null and b/images/cloud/guides/getting-started/environment-form.png differ diff --git a/images/cloud/guides/getting-started/feature-flag-in-repository.png b/images/cloud/guides/getting-started/feature-flag-in-repository.png new file mode 100644 index 00000000..6a81572c Binary files /dev/null and b/images/cloud/guides/getting-started/feature-flag-in-repository.png differ diff --git a/images/cloud/guides/getting-started/flipt-ui.png b/images/cloud/guides/getting-started/flipt-ui.png new file mode 100644 index 00000000..7a40a2aa Binary files /dev/null and b/images/cloud/guides/getting-started/flipt-ui.png differ diff --git a/images/cloud/guides/getting-started/flipt.png b/images/cloud/guides/getting-started/flipt.png deleted file mode 100644 index e0ee5890..00000000 Binary files a/images/cloud/guides/getting-started/flipt.png and /dev/null differ diff --git a/images/cloud/guides/getting-started/login.png b/images/cloud/guides/getting-started/login.png deleted file mode 100644 index 0df62ffe..00000000 Binary files a/images/cloud/guides/getting-started/login.png and /dev/null differ diff --git a/images/cloud/guides/getting-started/repository.png b/images/cloud/guides/getting-started/repository.png new file mode 100644 index 00000000..414378d5 Binary files /dev/null and b/images/cloud/guides/getting-started/repository.png differ diff --git a/images/cloud/guides/getting-started/select-repository.png b/images/cloud/guides/getting-started/select-repository.png new file mode 100644 index 00000000..816d9045 Binary files /dev/null and b/images/cloud/guides/getting-started/select-repository.png differ diff --git a/images/cloud/guides/production/api-key-created.png b/images/cloud/guides/production/api-key-created.png new file mode 100644 index 00000000..2f7306eb Binary files /dev/null and b/images/cloud/guides/production/api-key-created.png differ diff --git a/images/cloud/guides/production/dashboard-connected.png b/images/cloud/guides/production/dashboard-connected.png deleted file mode 100644 index 6ec2063b..00000000 Binary files a/images/cloud/guides/production/dashboard-connected.png and /dev/null differ diff --git a/images/cloud/guides/production/dashboard.png b/images/cloud/guides/production/dashboard.png deleted file mode 100644 index 5cb74ad2..00000000 Binary files a/images/cloud/guides/production/dashboard.png and /dev/null differ diff --git a/images/cloud/guides/production/download-configuration.png b/images/cloud/guides/production/download-configuration.png deleted file mode 100644 index b794c18c..00000000 Binary files a/images/cloud/guides/production/download-configuration.png and /dev/null differ diff --git a/images/cloud/guides/production/edit-environment.png b/images/cloud/guides/production/edit-environment.png new file mode 100644 index 00000000..36694e27 Binary files /dev/null and b/images/cloud/guides/production/edit-environment.png differ diff --git a/images/cloud/guides/production/environment-connected.png b/images/cloud/guides/production/environment-connected.png deleted file mode 100644 index 217c98c9..00000000 Binary files a/images/cloud/guides/production/environment-connected.png and /dev/null differ diff --git a/images/cloud/guides/production/environment-form.png b/images/cloud/guides/production/environment-form.png deleted file mode 100644 index ebc05591..00000000 Binary files a/images/cloud/guides/production/environment-form.png and /dev/null differ diff --git a/images/cloud/guides/production/flipt.png b/images/cloud/guides/production/flipt.png deleted file mode 100644 index c083af6e..00000000 Binary files a/images/cloud/guides/production/flipt.png and /dev/null differ diff --git a/images/cloud/guides/production/name-api-key.png b/images/cloud/guides/production/name-api-key.png new file mode 100644 index 00000000..2074efb0 Binary files /dev/null and b/images/cloud/guides/production/name-api-key.png differ diff --git a/images/cloud/guides/production/security.png b/images/cloud/guides/production/security.png new file mode 100644 index 00000000..931baeeb Binary files /dev/null and b/images/cloud/guides/production/security.png differ diff --git a/images/cloud/hybrid-cloud.png b/images/cloud/hybrid-cloud.png deleted file mode 100644 index a70f951f..00000000 Binary files a/images/cloud/hybrid-cloud.png and /dev/null differ diff --git a/integration/overview.mdx b/integration/overview.mdx index a407d06b..79155bbd 100644 --- a/integration/overview.mdx +++ b/integration/overview.mdx @@ -4,7 +4,7 @@ description: This document describes how to integrate Flipt in your existing app --- - To learn how to install and run Flipt, see the [Installation](/installation) + To learn how to install and run Flipt, see the [Self-Hosted](/self-hosted) documentation. diff --git a/introduction.mdx b/introduction.mdx index f03dedb0..e958b486 100644 --- a/introduction.mdx +++ b/introduction.mdx @@ -10,15 +10,19 @@ mimic an evaluation request from your applications. For more information on any of the concepts described, please see the [Concepts](/concepts) documentation. - - Combine the flexibility of deployment in your cloud with the robustness of - managed authentication and authorization. + + Flipt Managed Cloud is a fully managed feature management platform that + enables you to continue to use Flipt's feature management capabilities with + zero maintenance. + +Own your feature data, while still benefiting from our cloud-based management console. + ## Setup Before getting started, make sure the Flipt server is up and running on your -host on your chosen ports. See [Installation](/installation) for more. +host on your chosen ports. See [Self-Hosted](/self-hosted) for more. diff --git a/mint.json b/mint.json index d51b0b1b..dc6d0efa 100644 --- a/mint.json +++ b/mint.json @@ -36,7 +36,7 @@ }, "tabs": [ { - "name": "Enterprise Cloud", + "name": "Managed Cloud", "url": "cloud" }, { @@ -49,7 +49,7 @@ }, "anchors": [ { - "name": "Enterprise Cloud", + "name": "Managed Cloud", "icon": "cloud", "url": "cloud" }, @@ -209,13 +209,6 @@ "cli/commands/bundle/push" ] }, - { - "group": "cloud", - "pages":[ - "cli/commands/cloud/login", - "cli/commands/cloud/logout" - ] - }, "cli/commands/evaluate", "cli/commands/export", "cli/commands/import", @@ -262,29 +255,25 @@ "cloud/overview", "cloud/benefits", "cloud/concepts", + "cloud/architecture", { "group": "Features", "pages": [ "cloud/features/authentication", - "cloud/features/user-management", + "cloud/features/git-backed-storage", "cloud/features/rbac", - "cloud/features/audit-logs" + "cloud/features/user-management" + ] + }, + { + "group": "Guides", + "pages": [ + "cloud/guides/getting-started", + "cloud/guides/production" ] } ] }, - { - "group": "Guides", - "pages": [ - "cloud/guides/production" - ] - }, - { - "group": "Architecture", - "pages": [ - "cloud/architecture/overview" - ] - }, { "group": "Overview", "pages": ["reference/overview"] @@ -411,10 +400,6 @@ "source": "/integration/grpc", "destination": "/integration/server/grpc" }, - { - "source": "/managed/hybrid", - "destination": "/cloud/overview" - }, { "source":"/guides/get-going-with-gitops", "destination": "/guides/user/get-going-with-gitops" diff --git a/reference/overview.mdx b/reference/overview.mdx index 96eb3e25..62bcc45a 100644 --- a/reference/overview.mdx +++ b/reference/overview.mdx @@ -22,7 +22,7 @@ Head to the [Configuration: Authentication](/configuration#authentication) secti Flipt supports two types of authentication for the API: - **Client Token Authentication** - This method uses tokens stored by Flipt to authenticate the request. See the [Using Client Tokens](/authentication/using-tokens) section for more information. -- **JSON Web Token (JWT) Authentication** - This method uses a JWT token, created and signed externally from Flipt to authenticate the request. See the [Using JWT Tokens](/authentication/using-jwt) section for more information. +- **JSON Web Token (JWT) Authentication** - This method uses a JWT token, created and signed externally from Flipt to authenticate the request. See the [Using JWT Tokens](/authentication/using-jwts) section for more information. See the [Authentication](/authentication) documentation for more information on all supported authentication methods. diff --git a/self-hosted/kubernetes.mdx b/self-hosted/kubernetes.mdx index 7054a050..7c582bd9 100644 --- a/self-hosted/kubernetes.mdx +++ b/self-hosted/kubernetes.mdx @@ -6,7 +6,8 @@ description: "Deploy Flipt to Kubernetes using the Helm chart" The chart is hosted in the [Flipt Helm repository](https://helm.flipt.io) and is open source. - Checkout our [Deploy to Kubernetes](/guides/deploy-to-kubernetes) guide for an + Checkout our [Deploy to + Kubernetes](/guides/operation/deployment/deploy-to-kubernetes) guide for an in-depth look into deploying Flipt to Kubernetes using our Helm chart. diff --git a/self-hosted/overview.mdx b/self-hosted/overview.mdx index b5c0476b..64a34e28 100644 --- a/self-hosted/overview.mdx +++ b/self-hosted/overview.mdx @@ -37,8 +37,8 @@ For more details on each installation method, see the sections below. - [Homebrew](#homebrew) - [Binary](#binary) - - Don't want to self-host? Learn more about our managed offerings. + + Don't want to self-host? Learn more about our managed offering. ## Homebrew diff --git a/usecases/gitops.mdx b/usecases/gitops.mdx index f642fb60..78c99d28 100644 --- a/usecases/gitops.mdx +++ b/usecases/gitops.mdx @@ -23,7 +23,7 @@ Flipt's declarative storage backends allow it to run without a database at all. Our git support enables you to evaluate feature flags across different branches and tags. This allows developers to test feature flags in a staging environment before merging them into production, or leverage preview environments to test feature flags in isolation. -Read our [Get Going with GitOps](https://www.flipt.io/docs/guides/get-going-with-gitops) guide to learn how to get started with GitOps and Flipt. +Read our [Get Going with GitOps](https://www.flipt.io/docs/guides/user/get-going-with-gitops) guide to learn how to get started with GitOps and Flipt. ## CI/CD Integration diff --git a/usecases/overview.mdx b/usecases/overview.mdx index f879c493..341744a2 100644 --- a/usecases/overview.mdx +++ b/usecases/overview.mdx @@ -44,4 +44,4 @@ Feature flags can be utilized for continuous configuration management. This allo ## Learn More -These are just some of the many use cases for Flipt and feature flags for developers. Reach out to our team on [Discord](/discord) or [GitHub](https://github.com/flipt-io/flipt) to find out how Flipt can support your specific use case. +These are just some of the many use cases for Flipt and feature flags for developers. Reach out to our team on [Discord](https://flipt.io/discord) or [GitHub](https://git.new/flipt) to find out how Flipt can support your specific use case.