Skip to content
This repository has been archived by the owner on Mar 21, 2024. It is now read-only.

Configuration File Support #185

Merged
merged 15 commits into from
Nov 29, 2022
Merged

Configuration File Support #185

merged 15 commits into from
Nov 29, 2022

Conversation

gmourier
Copy link
Member

@gmourier gmourier commented Oct 18, 2022 •
edited
Loading

Summary

Meilisearch options can be defined in a .toml configuration file being loaded at launch.

Teams can easily version, track, and share configuration files. It makes it easier to learn about the different options available and to define at a glance how Meilisearch is configured.

A default config file is defined as config.toml and is retrieved by Meilisearch by default in its current working directory.

The current consistency rule is that all environment variables and launch options are configurable by a dedicated key in the configuration file.

Configuration keys are named following the snake_case convention from the name of a CLI option. That is, --import-dump must be named import_dump within the configuration file.

There is an exception rule. The config_file_path key is not accepted in the configuration file and stops Meilisearch from being launched if specified.

Changes

  • Adds MEILI_CONFIG_FILE_PATH env var
  • Adds --config-file-path CLI option
  • Adds 0185-configuration-file.md specification file
  • Adds infos.with_configuration_file telemetry

Out Of Scope

N/A

Attention To Reviewers

n/a

Misc

  • Update telemetry datapoints

@gmourier gmourier added Draft Feature specification is in draft state. Summary and Motivation parts need to be written. v0.30 Q4:2022 labels Oct 18, 2022
@gmourier gmourier mentioned this pull request Oct 18, 2022
Merged
1 task
@curquiza curquiza mentioned this pull request Oct 18, 2022
Closed
6 tasks
@gmourier gmourier added Ready For Review Feature specification must be reviewed. In Progress Feature specification is in elaboration. Important changes can still occurs in the specification. and removed Draft Feature specification is in draft state. Summary and Motivation parts need to be written. Ready For Review Feature specification must be reviewed. labels Oct 19, 2022
@gmourier gmourier marked this pull request as ready for review October 19, 2022 09:13
@gmourier gmourier requested a review from curquiza October 19, 2022 09:13
@gmourier gmourier added Ready For Review Feature specification must be reviewed. and removed In Progress Feature specification is in elaboration. Important changes can still occurs in the specification. labels Oct 19, 2022
@gmourier gmourier requested a review from irevoire October 19, 2022 09:43
curquiza
curquiza suggested changes Oct 20, 2022
View reviewed changes
text/0185-configuration-file.md Outdated Show resolved Hide resolved
text/0185-configuration-file.md Outdated Show resolved Hide resolved
text/0185-configuration-file.md Outdated Show resolved Hide resolved
text/0185-configuration-file.md Outdated Show resolved Hide resolved
text/0185-configuration-file.md Outdated Show resolved Hide resolved
text/0185-configuration-file.md Outdated Show resolved Hide resolved
@maryamsulemani97 maryamsulemani97 mentioned this pull request Oct 25, 2022
Closed
gmourier and others added 6 commits October 26, 2022 19:14
@gmourier @curquiza
Update text/0185-configuration-file.md
ebf9687 
Co-authored-by: Clémentine Urquizar - curqui <clementine@meilisearch.com>
@gmourier
Replace config file by configuration file in the error message
3aa5651
@gmourier @curquiza
Update text/0185-configuration-file.md
812ccb4 
Co-authored-by: Clémentine Urquizar - curqui <clementine@meilisearch.com>
@gmourier @curquiza
Update text/0185-configuration-file.md
c204f01 
Co-authored-by: Clémentine Urquizar - curqui <clementine@meilisearch.com>
@gmourier @curquiza
Update text/0185-configuration-file.md
8539b31 
Co-authored-by: Clémentine Urquizar - curqui <clementine@meilisearch.com>
@gmourier @curquiza
Update text/0185-configuration-file.md
2793b75 
Co-authored-by: Clémentine Urquizar - curqui <clementine@meilisearch.com>
@gmourier gmourier requested a review from curquiza November 2, 2022 18:02
@gmourier gmourier added the Telemetry Update the telemetry collect. label Nov 2, 2022
@gmourier
Copy link
Member Author

gmourier commented Nov 2, 2022

@irevoire I've added the telemetry changes

@gmourier gmourier mentioned this pull request Nov 2, 2022
Closed
1 task
curquiza
curquiza approved these changes Nov 7, 2022
View reviewed changes
text/0185-configuration-file.md Outdated Show resolved Hide resolved
@gmourier @curquiza
Update text/0185-configuration-file.md
8ad8b2f 
Co-authored-by: Clémentine Urquizar - curqui <clementine@meilisearch.com>
irevoire
irevoire suggested changes Nov 14, 2022
View reviewed changes
text/0185-configuration-file.md Outdated Show resolved Hide resolved
text/0185-configuration-file.md Outdated Show resolved Hide resolved
text/0185-configuration-file.md Outdated Show resolved Hide resolved
gmourier and others added 3 commits November 16, 2022 11:23
@gmourier @irevoire
Update text/0185-configuration-file.md
43cf41e 
Co-authored-by: Tamo <tamo@meilisearch.com>
@gmourier @irevoire
Update text/0185-configuration-file.md
4ad6a94 
Co-authored-by: Tamo <tamo@meilisearch.com>
@gmourier @irevoire
Update text/0185-configuration-file.md
073e1d0 
Co-authored-by: Tamo <tamo@meilisearch.com>
@gmourier gmourier requested a review from irevoire November 16, 2022 10:23
@gmourier gmourier added Implemented Feature specification has been implemented. and removed Ready For Review Feature specification must be reviewed. labels Nov 29, 2022
@gmourier gmourier merged commit 60d6f43 into release-v0.30.0 Nov 29, 2022
@gmourier gmourier deleted the config-file branch November 29, 2022 14:21
gmourier added a commit that referenced this pull request Nov 29, 2022
@gmourier @curquiza
@irevoire @Kerollmops @bidoubiwa @brunoocasali @ManyTheFish @alallema @dureuill
Release v0.30.0 (#176)
b2e4b3d 
* Bump Meilisearch OpenAPI spec to v0.30.0

* Compression Headers (#178)

* Start specification

* Rename spec file

* Rephrase summary

* Rephrase receiving a compressed response section

* Add links to RFC9910

* Introduce missing_master_key error (#179)

* Update error message (#180)

* Specify the error variant (#181)

* replaces 127.0.0.1 by localhost (#184)

* Configuration File Support (#185)

* init spec file

* Fill-in spec

* Fix typing errors

* adds errors case

* Update text/0185-configuration-file.md

Co-authored-by: Clémentine Urquizar - curqui <clementine@meilisearch.com>

* Replace config file by configuration file in the error message

* Update text/0185-configuration-file.md

Co-authored-by: Clémentine Urquizar - curqui <clementine@meilisearch.com>

* Update text/0185-configuration-file.md

Co-authored-by: Clémentine Urquizar - curqui <clementine@meilisearch.com>

* Update text/0185-configuration-file.md

Co-authored-by: Clémentine Urquizar - curqui <clementine@meilisearch.com>

* Update text/0185-configuration-file.md

Co-authored-by: Clémentine Urquizar - curqui <clementine@meilisearch.com>

* Add infos.with_configuration_file to telemetry-policies

* Update text/0185-configuration-file.md

Co-authored-by: Clémentine Urquizar - curqui <clementine@meilisearch.com>

* Update text/0185-configuration-file.md

Co-authored-by: Tamo <tamo@meilisearch.com>

* Update text/0185-configuration-file.md

Co-authored-by: Tamo <tamo@meilisearch.com>

* Update text/0185-configuration-file.md

Co-authored-by: Tamo <tamo@meilisearch.com>

Co-authored-by: Clémentine Urquizar - curqui <clementine@meilisearch.com>
Co-authored-by: Tamo <tamo@meilisearch.com>

* Telemetry - Missing events and options (#186)

* wip spec changes

* update telemetry

* add missing property to the full properties table

* Update text/0034-telemetry-policies.md

Co-authored-by: Tamo <tamo@meilisearch.com>

* Update text/0034-telemetry-policies.md

Co-authored-by: Tamo <tamo@meilisearch.com>

* Add distrinct_attribute.set property, Task Seen becomes an aggregated event, add missing sub settings properties to Settings Updated event

* Add requests.total_received property to Tasks Seen event

* add missing ranking rules metrics

* Update text/0034-telemetry-policies.md

Co-authored-by: Tamo <tamo@meilisearch.com>

* Update text/0034-telemetry-policies.md

Co-authored-by: Tamo <tamo@meilisearch.com>

* Update text/0034-telemetry-policies.md

Co-authored-by: Tamo <tamo@meilisearch.com>

* Precise max-index-size option (#187)

* Tasks API - Rename `receivedDocumentsIds` by `providedIds` (#188)

* Rename receivedDocumentsIds by matchedDocuments

* Update open-api.yaml

Co-authored-by: Clément Renault <renault.cle@gmail.com>

* Update open-api.yaml

Co-authored-by: Clément Renault <renault.cle@gmail.com>

* Update text/0060-tasks-api.md

Co-authored-by: Clément Renault <renault.cle@gmail.com>

* Add missing env vars, brings consistency (#190)

* Swap Indexes API (#192)

* Add new spec file as draft file

* Add specification file

* update spec

* draft open-api.yml changes

* Add errors

* fix typos

* Add Indexes Swapped event

* duplicate_index_found is synchronous

* Apply suggestions from code review

Co-authored-by: Clémentine Urquizar - curqui <clementine@meilisearch.com>

* Add review suggestions

* Precis mention for tasks indexUid target swap in the history

* Update open-api.yaml

Co-authored-by: Clément Renault <renault.cle@gmail.com>

* Update open-api.yaml

Co-authored-by: Clément Renault <renault.cle@gmail.com>

* Update open-api.yaml

Co-authored-by: Clément Renault <renault.cle@gmail.com>

* Update text/0061-error-format-and-definitions.md

Co-authored-by: Clément Renault <renault.cle@gmail.com>

* Update text/0191-swap-indexes-api.md

Co-authored-by: Clément Renault <renault.cle@gmail.com>

Co-authored-by: Clémentine Urquizar - curqui <clementine@meilisearch.com>
Co-authored-by: Clément Renault <renault.cle@gmail.com>

* Add snapshotCreation as a new task type to make it visible in the task history (#193)

* Tasks API - Add task priority order section (#194)

* Add 2.1 Task Priority section

* Precise other tasks priority ordering

* Search API - Page Selection Component (#196)

* Search API - numbered pagination

* Improve numbered pagination explaination

* Update text/0118-search-api.md

* Update text/0118-search-api.md

* Apply suggestions from code review

* Add links

* Update open api

* Add a dot at the end of the title

* Fix links

* Improve page and hitsperpage query params

* Refactor pagination guide

* Fix wording

* Add corner case

* Update open-api.yaml

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update open-api.yaml

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update open-api.yaml

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Apply wording changes from code review

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Apply suggestions from code review

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>
Co-authored-by: Bruno Casali <brunoocasali@gmail.com>

* Fix example

* Apply suggestions from code review

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update open-api.yaml

* Update text/0118-search-api.md

* Update links

* Add link to maxtotalhits

* Update text/0118-search-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Improve message in page reference

* Update text/0118-search-api.md

Co-authored-by: Many the fish <legendre.maxime.isn@gmail.com>

* Add telemetry to know the most used search results navigation methods in a batch

* Update text/0118-search-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0118-search-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>
Co-authored-by: Bruno Casali <brunoocasali@gmail.com>
Co-authored-by: Many the fish <legendre.maxime.isn@gmail.com>

* Tasks API - Add task cancelation capability (#195)

* Add cancel to task spec

* Remove missing error

* Fix typo on cancels

* Fix IndexUid always null

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Add canceledBy and missing_filters error

* Merge 11.1 filter iwth get and 11.2 filter with post

* Specified every date filter

* Change uid as integer and not as string

* Add auto-batching and error

* Add new route task/cancel api-key

* Add global task note

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0060-tasks-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0061-error-format-and-definitions.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Modification due to review

* Modification due to review

* Modification due to review

* Modification due to review

* Fix global task link

* Fix format link

* Add open-api modification

* Remove trailing space

* Add clarification

* Add errors definition

* Update open-api.yml

* fix task uid query parameter name

* Fix collission between url path and query parameters

* fmt open-api.yml

* Add telemetry details

* Add 202_taskCancelation example

* Update originalQuery to originalFilters and update missing_task_filter to missing_task_filters

* matchedTasks is computed when the task is enqueued

* Apply suggestions from code review

Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>

* Recall explanation for filter query parameter and mentions that limit and from are valid on

* Fix typo in property name

* Update query paramters name and related error codes when invalid

* Fix missing part of error msg

* Precise valid date formats

* Add supported format for date filters in open-api.yml

* Update open-api.yaml

Co-authored-by: Clément Renault <renault.cle@gmail.com>

* Update text/0060-tasks-api.md

Co-authored-by: Clément Renault <renault.cle@gmail.com>

* fix typo

* Update open-api.yaml

Co-authored-by: Clément Renault <renault.cle@gmail.com>

* Update text/0060-tasks-api.md

* Update text/0060-tasks-api.md

* Tasks API - Add task deletion capability (#198)

* Describes task deletion feature additions

* Update open-api.yml

* Update telemetry-policies

* Update originalQuery to originalFilters

* Follow title structure

* Introduce review feedback

* Branch the right components

* Update text/0060-tasks-api.md

Co-authored-by: Clément Renault <renault.cle@gmail.com>

Co-authored-by: Clément Renault <renault.cle@gmail.com>

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>
Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>
Co-authored-by: Clément Renault <renault.cle@gmail.com>

* Update the dump support table with the dumpv6 (#199)

* Settings API - Specify handling of null values when patching settings (#202)

* Specify behavior when patching a setting with partial values and null values.

- Partial value: the setting is unchanged.
- null value: the setting is reset to default.

* Settings: Update error messages to accept the null value

* Add missing task types

* Add canceledTasks details

Co-authored-by: Clémentine Urquizar - curqui <clementine@meilisearch.com>
Co-authored-by: Tamo <tamo@meilisearch.com>
Co-authored-by: Clément Renault <renault.cle@gmail.com>
Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>
Co-authored-by: Bruno Casali <brunoocasali@gmail.com>
Co-authored-by: Many the fish <legendre.maxime.isn@gmail.com>
Co-authored-by: Amélie <alallema@users.noreply.github.com>
Co-authored-by: Louis Dureuil <louis.dureuil@gmail.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@curquiza curquiza curquiza approved these changes

@irevoire irevoire Awaiting requested review from irevoire

Assignees
No one assigned
Labels
Implemented Feature specification has been implemented. Q4:2022 Telemetry Update the telemetry collect. v0.30
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@gmourier @irevoire @curquiza