diff --git a/configuration/storage.mdx b/configuration/storage.mdx index b58fcbf..7ea55e2 100644 --- a/configuration/storage.mdx +++ b/configuration/storage.mdx @@ -105,7 +105,9 @@ whereas, the `git` and `object` backends are intended for production and serve f ### Read Only Mode -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. +![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. ### Local @@ -284,8 +286,8 @@ These files declaratively define what flags, segments, variants, etc. exist and #### Locating Flag State Flipt's filesystem backends allow you to define feature flags alongside other configurations in a shared directory, repository, or object storage bucket. -In order to identify which files are intended for Flipt, it uses a naming scheme to index which are flag state files. -By default, Flipt will look for the following filename patterns when identifying files to attempt to parse as Flipt state: + +Flipt uses a naming scheme to index which files are flag state files. By default, Flipt will look for the following filename patterns to attempt to parse as Flipt state: - `**/features.yaml` - `**/features.yml` @@ -294,8 +296,7 @@ By default, Flipt will look for the following filename patterns when identifying Any file named `features.yaml`, `features.yml`, or with either extension `.features.yaml` or `.features.yml` is considered recursively from the root of your target. -If this naming convention doesn't work for you, it can be overridden by creating a file named `.flipt.yml` in the root of your target directory tree. -This file will be used to instruct Flipt on how to index your directory tree and find flag state files: +If this naming convention doesn't work for you, it can be overridden by creating a file named `.flipt.yml` in the root of your target directory tree. This file will be used to instruct Flipt on how to index your directory tree and find flag state files: ```yaml version: "1.0" @@ -318,7 +319,7 @@ Flipt flag state file format has been taken directly from Flipt's existing [import and export](/operations/import-export) flag state format. You can run `flipt export` on your existing Flipt instance, and then -add/commit the result to a directory, object storage, or Git repository to get started quickly. +add/commit the result to a directory, object storage, or Git repository to get started. This can be used to migrate from a relational database-backed instance of Flipt to a filesystem-backed deployment with ease. diff --git a/images/concepts/constraints.png b/images/concepts/constraints.png index 9fdd227..16f2429 100644 Binary files a/images/concepts/constraints.png and b/images/concepts/constraints.png differ diff --git a/images/concepts/constraints_types.png b/images/concepts/constraints_types.png index 88899bf..13f6dfe 100644 Binary files a/images/concepts/constraints_types.png and b/images/concepts/constraints_types.png differ diff --git a/images/concepts/distributions.png b/images/concepts/distributions.png index 63ebf58..e9a043b 100644 Binary files a/images/concepts/distributions.png and b/images/concepts/distributions.png differ diff --git a/images/concepts/evaluation.png b/images/concepts/evaluation.png index 0645a98..08e564d 100644 Binary files a/images/concepts/evaluation.png and b/images/concepts/evaluation.png differ diff --git a/images/concepts/flags.png b/images/concepts/flags.png index a5db704..b82d97c 100644 Binary files a/images/concepts/flags.png and b/images/concepts/flags.png differ diff --git a/images/concepts/flags_boolean.png b/images/concepts/flags_boolean.png index 3ff03df..de8caf9 100644 Binary files a/images/concepts/flags_boolean.png and b/images/concepts/flags_boolean.png differ diff --git a/images/concepts/flags_variants.png b/images/concepts/flags_variants.png index d2b4731..2cf7310 100644 Binary files a/images/concepts/flags_variants.png and b/images/concepts/flags_variants.png differ diff --git a/images/concepts/namespaces_default.png b/images/concepts/namespaces_default.png index 079c056..0e0a69e 100644 Binary files a/images/concepts/namespaces_default.png and b/images/concepts/namespaces_default.png differ diff --git a/images/concepts/namespaces_production.png b/images/concepts/namespaces_production.png index 09b6ee2..6b73387 100644 Binary files a/images/concepts/namespaces_production.png and b/images/concepts/namespaces_production.png differ diff --git a/images/concepts/rollouts.png b/images/concepts/rollouts.png index 8c6b3c8..243bc5a 100644 Binary files a/images/concepts/rollouts.png and b/images/concepts/rollouts.png differ diff --git a/images/concepts/rules.png b/images/concepts/rules.png index c481418..7fcb123 100644 Binary files a/images/concepts/rules.png and b/images/concepts/rules.png differ diff --git a/images/concepts/segments.png b/images/concepts/segments.png index 675800c..54b5429 100644 Binary files a/images/concepts/segments.png and b/images/concepts/segments.png differ diff --git a/images/concepts/settings_namespaces.png b/images/concepts/settings_namespaces.png index 426db2a..c693bf5 100644 Binary files a/images/concepts/settings_namespaces.png and b/images/concepts/settings_namespaces.png differ diff --git a/images/configuration/readonly.png b/images/configuration/readonly.png new file mode 100644 index 0000000..7b46393 Binary files /dev/null and b/images/configuration/readonly.png differ diff --git a/images/getting_started/create_constraint.png b/images/getting_started/create_constraint.png index a73c243..8b0a10d 100644 Binary files a/images/getting_started/create_constraint.png and b/images/getting_started/create_constraint.png differ diff --git a/images/getting_started/create_flag.png b/images/getting_started/create_flag.png index 1d4c0a1..a71da3c 100644 Binary files a/images/getting_started/create_flag.png and b/images/getting_started/create_flag.png differ diff --git a/images/getting_started/create_rule.png b/images/getting_started/create_rule.png index a872863..209fbb6 100644 Binary files a/images/getting_started/create_rule.png and b/images/getting_started/create_rule.png differ diff --git a/images/getting_started/create_segment.png b/images/getting_started/create_segment.png index 6bd91e7..32a5929 100644 Binary files a/images/getting_started/create_segment.png and b/images/getting_started/create_segment.png differ diff --git a/images/getting_started/create_variant.png b/images/getting_started/create_variant.png index 449ac0e..5841527 100644 Binary files a/images/getting_started/create_variant.png and b/images/getting_started/create_variant.png differ diff --git a/images/getting_started/evaluation_console.png b/images/getting_started/evaluation_console.png index b36d6bb..9e0928c 100644 Binary files a/images/getting_started/evaluation_console.png and b/images/getting_started/evaluation_console.png differ diff --git a/operations/import-export.mdx b/operations/import-export.mdx index 023a384..655f7e9 100644 --- a/operations/import-export.mdx +++ b/operations/import-export.mdx @@ -17,8 +17,7 @@ Both `HTTP` and `gRPC` are supported by the `--address` flag. ## Import -To import data into Flipt, use the `flipt import` command. You -can import either from a file or from STDIN. +To import data into Flipt, use the `flipt import` command. You can either import from a file or from STDIN. To import from STDIN, Flipt requires the `--stdin` flag: @@ -26,39 +25,18 @@ To import from STDIN, Flipt requires the `--stdin` flag: cat flipt.yaml | flipt import --stdin ``` -If not importing using `--stdin`, Flipt requires the file to be imported as an -argument: +If not importing using `--stdin`, Flipt requires the file to be imported as an argument: ```yaml flipt import flipt.yaml ``` -By default, Flipt will import into the `default` namespace. -Use the flag `--namespace` to import into a different namespace. - -```yaml -flipt import --namespace production flipt.yaml -``` - -A namespace must exist before your import into it. -For convenience, you can supply `--create-namespace` in order for Flipt to automatically create the namespace if it doesn't already exist. - -```yaml -flipt import --namespace production --create-namespace flipt.yaml -``` - - In [v1.28.0](https://github.com/flipt-io/flipt/releases/tag/v1.28.0), we introduced some breaking changes to `import`. - -You no longer have to use the `--namespace` or `--create-namespace` flags to import resources into a specific namespace. - -The namespaces are now inferred from the YAML documents themselves. If a namespace your document refers to does not exist in the database, it will be created. - + Namespaces are inferred from the YAML documents themselves. If a namespace + your document refers to doesn't exist in the database, it will be created. -This command supports the `--drop` flag that will drop all data in your -Flipt database tables before importing. This is to ensure that no data -collisions occur during the import. +This command supports the `--drop` flag that will drop all data in your Flipt database tables before importing. This is to ensure that no data collisions occur during the import. Be careful when using the `--drop` flag as it will immediately drop all data @@ -66,6 +44,8 @@ collisions occur during the import. running this command just to be safe. +See the [CLI reference](/cli/commands/import) for more information on the `import` command. + ## Export To export Flipt data, use the `flipt export` command. @@ -94,20 +74,15 @@ flags: flipt export -o flipt.yaml ``` -By default, Flipt will export from the `default` namespace. -Use the flag `--namespace` to export from a different namespace. +By default, Flipt will export from the `default` namespace. Use the flag `--namespaces` to export from a different namespace or multiple namespaces. ```yaml -flipt export --namespace production +flipt export --namespaces production ``` - - In [v1.28.0](https://github.com/flipt-io/flipt/releases/tag/v1.28.0), we have extended this functionality to support exporting state from multiple namespaces to a single YAML file. - -The `--namespace` flag is now deprecated. - -The `--namespaces` flag will accept a comma-delimited list of namespaces from which you would like to export from. + + The `--all-namespaces` flag is a boolean flag that tells export to export all + namespaces. + -The `--all-namespaces flag is a boolean flag that tells export to export all namespaces to the single file you specify, or to standard out by default. - - +See the [CLI reference](/cli/commands/export) for more information on the `export` command.