diff --git a/.vale/styles/Flipt/spelling-exceptions.txt b/.vale/styles/Flipt/spelling-exceptions.txt index 76d6974..278b2bb 100644 --- a/.vale/styles/Flipt/spelling-exceptions.txt +++ b/.vale/styles/Flipt/spelling-exceptions.txt @@ -57,6 +57,7 @@ sdks sqlite unary uncomment +uncompromised URIs yaml zipkin \ No newline at end of file diff --git a/images/managed/byoc-dark.png b/images/managed/byoc-dark.png new file mode 100644 index 0000000..77ac1f4 Binary files /dev/null and b/images/managed/byoc-dark.png differ diff --git a/images/managed/byoc-light.png b/images/managed/byoc-light.png new file mode 100644 index 0000000..81397da Binary files /dev/null and b/images/managed/byoc-light.png differ diff --git a/images/managed/hybrid-dark.png b/images/managed/hybrid-dark.png new file mode 100644 index 0000000..efadba5 Binary files /dev/null and b/images/managed/hybrid-dark.png differ diff --git a/images/managed/hybrid-light.png b/images/managed/hybrid-light.png new file mode 100644 index 0000000..987f40d Binary files /dev/null and b/images/managed/hybrid-light.png differ diff --git a/installation.mdx b/installation.mdx deleted file mode 100644 index 70ec410..0000000 --- a/installation.mdx +++ /dev/null @@ -1,197 +0,0 @@ ---- -title: "Installation" ---- - -## Quickstart - -Flipt is a single binary that can be run on any Linux or macOS (arm64) host. You can install and try out Flipt in a few different ways: - - - -```console Binary -curl -fsSL https://github.com/flipt-io/flipt/raw/main/install.sh | sh -``` - -```console Docker -docker run -d \ - -p 8080:8080 \ - -p 9000:9000 \ - -v $HOME/flipt:/var/opt/flipt \ - docker.flipt.io/flipt/flipt:latest -``` - -```console Kubernetes/Helm -helm repo add flipt https://helm.flipt.io -helm install flipt flipt/flipt -``` - -```console Homebrew -brew install flipt-io/brew/flipt -``` - - - -For more details on each installation method, see the sections below. - -## Docker - -The simplest way to run Flipt is via Docker. This streamlines the installation -and configuration by using a reliable runtime. - -### Prerequisites - -Docker installation is required on the host, see the [official installation docs](https://docs.docker.com/install/). - - - Flipt requires Docker Engine version - [20.10](https://docs.docker.com/engine/release-notes/20.10/) or higher. - - -### Running - -```console -docker run -d \ - -p 8080:8080 \ - -p 9000:9000 \ - -v $HOME/flipt:/var/opt/flipt \ - docker.flipt.io/flipt/flipt:latest -``` - -This will download the image and start a Flipt container and publish ports -needed to access the UI and backend server. All persistent Flipt data will be -stored in `$HOME/flipt`. - - - `$HOME/flipt` is just used as an example, you can use any directory you would - like on the host. - - -The Flipt container uses host-mounted volumes to persist data: - -| Host location | Container location | Purpose | -| ------------- | ------------------ | ---------------------------- | -| $HOME/flipt | /var/opt/flipt | For storing application data | - -This allows data to persist between Docker container restarts. - - - If you don't use mounted volumes to persist your data, your data will be lost - when the container exits! - - -After starting the container you can visit http://0.0.0.0:8080 to view the -application. - -Flipt runs without the root user in the Docker container. - -### Configuration - -A default configuration file within the image. To supply a custom configuration, update the `docker run` command to mount your local configuration into the container - -```console -docker run -d \ - -p 8080:8080 \ - -p 9000:9000 \ - -v $HOME/flipt:/var/opt/flipt \ - -v $HOME/flipt/config.yaml:/etc/flipt/config.yaml \ - docker.flipt.io/flipt/flipt:latest -``` - -## Kubernetes/Helm - -You can run Flipt in Kubernetes using the Flipt [Helm](https://helm.sh) chart. - -Any issues or suggestions on how to improve the Flipt Helm chart are welcome in the [chart repository](https://github.com/flipt-io/helm-charts). - - - Checkout our new [Deploy to Kubernetes](/guides/deploy-to-kubernetes) guide - for an in-depth look into deploying Flipt to Kubernetes using our Helm chart. - - -### Prerequisites - -[Helm](https://helm.sh) must be installed to use the chart. Please refer to -Helm's [documentation](https://helm.sh/docs/) to get started. - -Once Helm is set up properly, add the Flipt Helm repository as follows: - -```console -helm repo add flipt https://helm.flipt.io -``` - -### Installing - -You can install the Flipt Helm chart with the following command: - -```console -helm install flipt flipt/flipt -``` - -## Homebrew - -You can install Flipt using [Homebrew](https://brew.sh/) on macOS and Linux. - -Flipt runs as a service and is managed by [Homebrew Services](https://github.com/Homebrew/homebrew-services). This means you can start and stop Flipt using the `brew services` command. - -### Installing - -```console -brew install flipt-io/brew/flipt -``` - -### Running - -```console -brew services start flipt -``` - -Alternatively, you can start Flipt in the foreground using: - -```console -flipt -``` - -## Binary - -You can always download the latest release archive of Flipt from the -[Releases](https://github.com/flipt-io/flipt/releases) section on GitHub. - -### Installing - -You can use the following script to download and install the latest Flipt binary: - -```console -curl -fsSL https://github.com/flipt-io/flipt/raw/main/install.sh | sh -``` - -View the [install.sh](https://github.com/flipt-io/flipt/blob/main/install.sh) source for more details. - -### Running - -Run the Flipt binary with: - -```console -./flipt [--config OPTIONAL_PATH_TO_YOUR_CONFIG] -``` - -Flipt will check in a few different locations for server configuration (in order): - -1. `--config` flag as an override -2. `{{ USER_CONFIG_DIR }}/flipt/config.yml` (the `USER_CONFIG_DIR` value is based on your architecture and specified in the [Go documentation](https://pkg.go.dev/os#UserConfigDir)) -3. `/etc/flipt/config/default.yml` - -See the [Configuration](/configuration) section for more details. - -## Supported Architectures - -Flipt is built for the following architectures/os: - -- **amd64** / **linux** -- **arm64** / **linux** -- **arm64** / **darwin** - -You can find the binaries for each architecture in the [Latest Release](https://github.com/flipt-io/flipt/releases/latest) assets section on GitHub. - -The [Docker image](https://hub.docker.com/r/flipt/flipt/tags) for Flipt is also multi-arch and supports both **amd64** and **arm64** architectures on **Linux**. - -If you need a different architecture, please open an issue on the [GitHub repository](https://github.com/flipt-io/flipt/issues) and we will try to accommodate your request. diff --git a/managed/byoc.mdx b/managed/byoc.mdx new file mode 100644 index 0000000..323c1c5 --- /dev/null +++ b/managed/byoc.mdx @@ -0,0 +1,31 @@ +--- +title: Bring Your Own Cloud +description: Tailor Flipt to your unique infrastructure needs with our BYOC offering. +--- + + + + + + +**Embrace the Power of Convenience with Flipt’s BYOC Offering** + +- **Effortless Deployment**: Seamlessly integrate Flipt into your existing cloud ecosystem. Our turn-key solution ensures rapid deployment, letting you leverage Flipt’s capabilities without the hassle of setup. + +- **Expert Management at Your Service**: Leave the complexities of installation, configuration, and ongoing operations to us. Our dedicated team ensures that your Flipt instance is always running optimally, allowing you to focus on what you do best. + +- **Dedicated Support, Tailored to You**: Experience unparalleled support with direct access to the Flipt team. Our experts work closely with you, ensuring a personalized approach that aligns with your unique infrastructure needs. + +- **Rapid, Production-Ready Setup**: Transform your feature flag management in minutes. We guarantee a production-ready Flipt instance swiftly, minimizing downtime and maximizing efficiency. + +- **Customized Integration for Your Infrastructure**: Your infrastructure is unique, and so is our integration approach. We tailor Flipt to fit seamlessly within your distinct ecosystem, ensuring compatibility and enhancing performance. + +- **The SaaS Advantage, Enhanced Security**: Enjoy the benefits of a SaaS model without compromising on security or experiencing latency issues. Our BYOC solution offers the best of both worlds, providing a secure, high-performance environment for your feature flag needs. + +Interested in piloting Flipt’s BYOC offering? [Sign Up as a Design Partner](https://1ld82idjvlr.typeform.com/to/s7YfGviE) or get in touch at [dev@flipt.io](mailto:dev@flipt.io). diff --git a/managed/hybrid.mdx b/managed/hybrid.mdx new file mode 100644 index 0000000..8adee8f --- /dev/null +++ b/managed/hybrid.mdx @@ -0,0 +1,31 @@ +--- +title: Hybrid Cloud +description: Use our Cloud offering as the simplest, scalable and managed backend for running Flipt open-source on your infrastructure +--- + + + + + + +**Introducing Flipt Hybrid Cloud: A Seamless Blend of Flexibility and Control** + +- **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. + +- **Streamlined Managed Storage**: Opt for Flipt Cloud as your managed storage backend, eliminating the need for additional setups. Enjoy uncompromised performance with a storage solution that's tailored to your needs. + +- **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. + +- **Effortless User Management**: Simplify user authentication and login processes without extra configuration or hosting expenses. Our platform is designed for ease, making user management a breeze right out of the box. + +- **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. + +- **Future-Proof Your Operations with Advanced Features**: Stay ahead with plans for in-application audit logging, metrics, and insights. Our upcoming features are designed to provide deep insights and enhanced control, helping you make data-driven decisions with ease. + +Interested in piloting our Hybrid Cloud offering? [Sign Up as a Design Partner](https://1ld82idjvlr.typeform.com/to/s7YfGviE) or get in touch at [dev@flipt.io](mailto:dev@flipt.io). diff --git a/managed/overview.mdx b/managed/overview.mdx new file mode 100644 index 0000000..9d37aa4 --- /dev/null +++ b/managed/overview.mdx @@ -0,0 +1,39 @@ +--- +title: Overview +description: Learn about the managed offerings we're building +--- + +At Flipt, we're pioneering the next generation of feature flag management with two innovative offerings: Bring Your Own Cloud (BYOC) and Hybrid Cloud. + +Both solutions are designed to seamlessly integrate into your existing infrastructure, providing unparalleled efficiency, security, and ease of use. + +Read on to learn more about these exciting new offerings and how you can get involved. + + + + Embrace the convenience of a managed service while retaining full control in + your cloud environment. + + + Combine the flexibility of deployment in your cloud with the robustness of + managed storage. + + + +**Bring Your Own Cloud: Customized Control in Your Cloud Environment** + +- Our BYOC offering ensures rapid, hassle-free deployment, expert management, and tailored integration, all within your existing cloud account. + +**Hybrid Cloud: The Best of Both Worlds** + +- Our Hybrid Cloud solution offers a streamlined setup, ready-to-use management interface, and simplified user and integration management, ensuring a smooth transition and enhanced operational efficiency. + +**Join Us as a Design Partner** + +We're actively iterating on these exciting concepts and looking for forward-thinking organizations to join us as design partners. This is a unique opportunity to shape the future of feature flag technology and tailor these solutions to your specific needs. + +If you're interested in piloting the BYOC or Hybrid Cloud solutions and contributing to their development, we'd love to hear from you. + +[Sign Up as a Design Partner](https://1ld82idjvlr.typeform.com/to/s7YfGviE) + +Your insights and feedback will be invaluable in refining these offerings to best serve organizations like yours. Join us in building the future of feature flags! diff --git a/mint.json b/mint.json index adbc20e..b96ea02 100644 --- a/mint.json +++ b/mint.json @@ -61,8 +61,23 @@ "pages": [ "introduction", "usecases", - "concepts", - "installation" + "concepts" + ] + }, + { + "group": "Self-Hosted", + "pages": [ + "self-hosted/overview", + "self-hosted/docker", + "self-hosted/kubernetes" + ] + }, + { + "group": "Managed", + "pages": [ + "managed/overview", + "managed/byoc", + "managed/hybrid" ] }, { @@ -263,6 +278,10 @@ { "source": "/experimental/filesystem-backends", "destination": "/configuration/storage" + }, + { + "source": "/installation", + "destination": "/self-hosted/overview" } ], "footerSocials": { diff --git a/self-hosted/docker.mdx b/self-hosted/docker.mdx new file mode 100644 index 0000000..8934bab --- /dev/null +++ b/self-hosted/docker.mdx @@ -0,0 +1,66 @@ +--- +title: "Docker" +description: "Running Flipt in a Docker container" +--- + +The simplest way to run Flipt is via Docker. This streamlines the installation +and configuration by using a reliable runtime. + +### Prerequisites + +Docker installation is required on the host, see the [official installation docs](https://docs.docker.com/install/). + + + Flipt requires Docker Engine version + [20.10](https://docs.docker.com/engine/release-notes/20.10/) or higher. + + +### Running + +```console +docker run -d \ + -p 8080:8080 \ + -p 9000:9000 \ + -v $HOME/flipt:/var/opt/flipt \ + docker.flipt.io/flipt/flipt:latest +``` + +This will download the image and start a Flipt container and publish ports +needed to access the UI and backend server. All persistent Flipt data will be +stored in `$HOME/flipt`. + + + `$HOME/flipt` is just used as an example, you can use any directory you would + like on the host. + + +The Flipt container uses host-mounted volumes to persist data: + +| Host location | Container location | Purpose | +| ------------- | ------------------ | ---------------------------- | +| $HOME/flipt | /var/opt/flipt | For storing application data | + +This allows data to persist between Docker container restarts. + + + If you don't use mounted volumes to persist your data, your data will be lost + when the container exits! + + +After starting the container you can visit http://0.0.0.0:8080 to view the +application. + +Flipt runs without the root user in the Docker container. + +### Configuration + +A default configuration file within the image. To supply a custom configuration, update the `docker run` command to mount your local configuration into the container + +```console +docker run -d \ + -p 8080:8080 \ + -p 9000:9000 \ + -v $HOME/flipt:/var/opt/flipt \ + -v $HOME/flipt/config.yaml:/etc/flipt/config.yaml \ + docker.flipt.io/flipt/flipt:latest +``` diff --git a/self-hosted/kubernetes.mdx b/self-hosted/kubernetes.mdx new file mode 100644 index 0000000..7054a05 --- /dev/null +++ b/self-hosted/kubernetes.mdx @@ -0,0 +1,32 @@ +--- +title: "Kubernetes" +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 + in-depth look into deploying Flipt to Kubernetes using our Helm chart. + + +Any issues or suggestions on how to improve the Flipt Helm chart are welcome in the [chart repository](https://github.com/flipt-io/helm-charts). + +### Prerequisites + +[Helm](https://helm.sh) must be installed to use the chart. Please refer to +Helm's [documentation](https://helm.sh/docs/) to get started. + +Once Helm is set up properly, add the Flipt Helm repository as follows: + +```console +helm repo add flipt https://helm.flipt.io +``` + +### Installing + +You can install the Flipt Helm chart with the following command: + +```console +helm install flipt flipt/flipt +``` diff --git a/self-hosted/overview.mdx b/self-hosted/overview.mdx new file mode 100644 index 0000000..9e0968a --- /dev/null +++ b/self-hosted/overview.mdx @@ -0,0 +1,107 @@ +--- +title: "Overview" +description: "Multiple ways to install and run Flipt on your own infrastructure" +--- + +Flipt is a single binary that can be run on any Linux or macOS (arm64) host. You can install and try out Flipt in a few different ways: + + + +```console Binary +curl -fsSL https://github.com/flipt-io/flipt/raw/main/install.sh | sh +``` + +```console Docker +docker run -d \ + -p 8080:8080 \ + -p 9000:9000 \ + -v $HOME/flipt:/var/opt/flipt \ + docker.flipt.io/flipt/flipt:latest +``` + +```console Kubernetes/Helm +helm repo add flipt https://helm.flipt.io +helm install flipt flipt/flipt +``` + +```console Homebrew +brew install flipt-io/brew/flipt +``` + + + +For more details on each installation method, see the sections below. + +- [Docker](/self-hosted/docker) +- [Kubernetes](/self-hosted/kubernetes) +- [Homebrew](#homebrew) +- [Binary](#binary) + +## Homebrew + +You can install Flipt using [Homebrew](https://brew.sh/) on macOS and Linux. + +Flipt runs as a service and is managed by [Homebrew Services](https://github.com/Homebrew/homebrew-services). This means you can start and stop Flipt using the `brew services` command. + +### Installing + +```console +brew install flipt-io/brew/flipt +``` + +### Running + +```console +brew services start flipt +``` + +Alternatively, you can start Flipt in the foreground using: + +```console +flipt +``` + +## Binary + +You can always download the latest release archive of Flipt from the +[Releases](https://github.com/flipt-io/flipt/releases) section on GitHub. + +### Installing + +You can use the following script to download and install the latest Flipt binary: + +```console +curl -fsSL https://github.com/flipt-io/flipt/raw/main/install.sh | sh +``` + +View the [install.sh](https://github.com/flipt-io/flipt/blob/main/install.sh) source for more details. + +### Running + +Run the Flipt binary with: + +```console +./flipt [--config OPTIONAL_PATH_TO_YOUR_CONFIG] +``` + +Flipt will check in a few different locations for server configuration (in order): + +1. `--config` flag as an override +2. `{{ USER_CONFIG_DIR }}/flipt/config.yml` (the `USER_CONFIG_DIR` value is based on your architecture and specified in the [Go documentation](https://pkg.go.dev/os#UserConfigDir)) +3. `/etc/flipt/config/default.yml` + +See the [Configuration](/configuration) section for more details. + +## Supported Architectures + +Flipt is built for the following architectures/os: + +- **amd64** / **linux** +- **arm64** / **linux** +- **arm64** / **darwin** + +You can find the binaries for each architecture in the [Latest Release](https://github.com/flipt-io/flipt/releases/latest) assets section on GitHub. + +The [Docker image](https://hub.docker.com/r/flipt/flipt/tags) for Flipt is also multi-arch and supports both **amd64** and **arm64** architectures on **Linux**. + +If you need a different architecture, please open an issue on the [GitHub repository](https://github.com/flipt-io/flipt/issues) and we will try to accommodate your request.