From c686cd6f60bd68d96c79156a2ae18651f7c78a5f Mon Sep 17 00:00:00 2001 From: Mark Phelps <209477+markphelps@users.noreply.github.com> Date: Fri, 22 Dec 2023 20:30:26 -0500 Subject: [PATCH] chore: update formatting --- configuration/storage.mdx | 56 ++++++++++++++++++++++----------------- self-hosted/overview.mdx | 8 +++--- 2 files changed, 36 insertions(+), 28 deletions(-) diff --git a/configuration/storage.mdx b/configuration/storage.mdx index cedfbf1..c06d2a0 100644 --- a/configuration/storage.mdx +++ b/configuration/storage.mdx @@ -119,15 +119,24 @@ when the migration container exits, having no effect on your Flipt instance! The following backend types are designed to support declarative management of feature flag state via a well-known file format. In particular, they're designed to support GitOps practices with minimal external dependencies. -Currently, we classify `local`, `git`, `object` and `oci` as the four declarative backends. -The `local` backend has been primarily developed to support a local development experience, -whereas, the `git`, `object` and `oci` backends are intended for production use. +The current four declarative backend types include: + +- [Local](#local-2) +- [Git](#git) +- [Object](#object) +- [OCI](#oci) + + + The `local` backend has been primarily developed to support a local + development experience, whereas, the `git`, `object` and `oci` backends are + intended for production use. + ### Read Only Mode ![Read Only Mode](/images/configuration/readonly.png) -Once enabled, all filesystem backends put the Flipt API and UI into a `read-only` mode that prevents Flipt from writing to the backend. This is useful for production environments where you want to ensure that flag state is only managed via the configured backend. +Once enabled, all declarative backends put the Flipt API and UI into a `read-only` mode that prevents Flipt from writing to the backend. This is useful for production environments where you want to ensure that flag state is only managed via the configured backend. You can also put Flipt into `read-only` mode by setting the @@ -331,7 +340,7 @@ The following is an example of how to configure Flipt to leverage this backend t In addition to these Flipt configuration parameters, valid credentials will - also be required for Flipt to authenticate with the target object-store. + also be required for Flipt to authenticate with the target object store. These should be provided as environment variables to the Flipt server process: @@ -379,23 +388,26 @@ The following is an example of how to configure Flipt to leverage this backend t In addition to these Flipt configuration parameters, valid credentials will - also be required for Flipt to authenticate with the target object-store. + also be required for Flipt to authenticate with the target object store. - These should be provided as environment variables to the Flipt server process. There are 2 options supported for authentication: - - * Using [Azure credentials](https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication?tabs=bash#2-authenticate-with-azure) - ```bash - AZURE_CLIENT_ID=... #Application ID of an Azure service principal - AZURE_TENANT_ID=... #ID of the application's Microsoft Entra tenant - AZURE_CLIENT_SECRET=... #Password of the Azure service principal - ``` - * Using Azure Blob storage [account keys](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal) - - ```bash - AZURE_STORAGE_ACCOUNT=... # account name - AZURE_STORAGE_KEY=... # secret shared key - ``` +These should be provided as environment variables to the Flipt server process. There are 2 options supported for authentication: + +- Using [Azure Credentials](https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication?tabs=bash#2-authenticate-with-azure) + +```bash +AZURE_CLIENT_ID=... # application ID of an Azure service principal +AZURE_TENANT_ID=... # ID of the application's Microsoft Entra tenant +AZURE_CLIENT_SECRET=... # password of the Azure service principal +``` + +- Using Azure Blob [Storage Account Keys](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal) + +```bash +AZURE_STORAGE_ACCOUNT=... +AZURE_STORAGE_KEY=... +``` + ### OCI Since `v1.31.0`, Flipt supports using any [OCI](https://opencontainers.org/) compatible registry as a declarative backend source. @@ -468,8 +480,6 @@ The indexing process first matches the `include` section and then filters that a #### Defining Flag State - - Flipt flag state file format has been taken directly from Flipt's existing [import and export](/operations/import-export) flag state format. @@ -478,8 +488,6 @@ add/commit the result to a directory, object storage, or Git repository to get s This can be used to migrate from a relational database-backed instance of Flipt to a filesystem-backed deployment with ease. - - ```yaml features.yaml namespace: backend flags: diff --git a/self-hosted/overview.mdx b/self-hosted/overview.mdx index 91824a2..22e18ef 100644 --- a/self-hosted/overview.mdx +++ b/self-hosted/overview.mdx @@ -100,12 +100,12 @@ See the [Configuration](/configuration) section for more details. Flipt is built for the following architectures/os: -- **amd64** / **linux** -- **arm64** / **linux** -- **arm64** / **darwin** +- **x86-64** / **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**. +The [Docker image](https://hub.docker.com/r/flipt/flipt/tags) for Flipt is multi-arch and supports both **x86-64** 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.