forgejo/docs/content/doc/administration
Jason Song 375fd15fbf
Refactor indexer (#25174)
Refactor `modules/indexer` to make it more maintainable. And it can be
easier to support more features. I'm trying to solve some of issue
searching, this is a precursor to making functional changes.

Current supported engines and the index versions:

| engines | issues | code |
| - | - | - |
| db | Just a wrapper for database queries, doesn't need version | - |
| bleve | The version of index is **2** | The version of index is **6**
|
| elasticsearch | The old index has no version, will be treated as
version **0** in this PR | The version of index is **1** |
| meilisearch | The old index has no version, will be treated as version
**0** in this PR | - |


## Changes

### Split

Splited it into mutiple packages

```text
indexer
├── internal
│   ├── bleve
│   ├── db
│   ├── elasticsearch
│   └── meilisearch
├── code
│   ├── bleve
│   ├── elasticsearch
│   └── internal
└── issues
    ├── bleve
    ├── db
    ├── elasticsearch
    ├── internal
    └── meilisearch
```

- `indexer/interanal`: Internal shared package for indexer.
- `indexer/interanal/[engine]`: Internal shared package for each engine
(bleve/db/elasticsearch/meilisearch).
- `indexer/code`: Implementations for code indexer.
- `indexer/code/internal`: Internal shared package for code indexer.
- `indexer/code/[engine]`: Implementation via each engine for code
indexer.
- `indexer/issues`: Implementations for issues indexer.

### Deduplication

- Combine `Init/Ping/Close` for code indexer and issues indexer.
- ~Combine `issues.indexerHolder` and `code.wrappedIndexer` to
`internal.IndexHolder`.~ Remove it, use dummy indexer instead when the
indexer is not ready.
- Duplicate two copies of creating ES clients.
- Duplicate two copies of `indexerID()`.


### Enhancement

- [x] Support index version for elasticsearch issues indexer, the old
index without version will be treated as version 0.
- [x] Fix spell of `elastic_search/ElasticSearch`, it should be
`Elasticsearch`.
- [x] Improve versioning of ES index. We don't need `Aliases`:
- Gitea does't need aliases for "Zero Downtime" because it never delete
old indexes.
- The old code of issues indexer uses the orignal name to create issue
index, so it's tricky to convert it to an alias.
- [x] Support index version for meilisearch issues indexer, the old
index without version will be treated as version 0.
- [x] Do "ping" only when `Ping` has been called, don't ping
periodically and cache the status.
- [x] Support the context parameter whenever possible.
- [x] Fix outdated example config.
- [x] Give up the requeue logic of issues indexer: When indexing fails,
call Ping to check if it was caused by the engine being unavailable, and
only requeue the task if the engine is unavailable.
- It is fragile and tricky, could cause data losing (It did happen when
I was doing some tests for this PR). And it works for ES only.
- Just always requeue the failed task, if it caused by bad data, it's a
bug of Gitea which should be fixed.

---------

Co-authored-by: Giteabot <teabot@gitea.io>
2023-06-23 12:37:56 +00:00
..
_index.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
_index.zh-cn.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
_index.zh-tw.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
adding-legal-pages.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
adding-legal-pages.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
backup-and-restore.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
backup-and-restore.zh-cn.md Remove unnecessary usage prefix from doc titles (#24869) 2023-05-23 18:14:57 +08:00
backup-and-restore.zh-tw.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
cmd-embedded.en-us.md Remove font-awesome and fomantic icon module (#24471) 2023-05-01 13:25:54 -04:00
cmd-embedded.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
command-line.en-us.md Update LDAP filters to include both username and email address (#24547) 2023-05-05 14:18:53 -04:00
command-line.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
config-cheat-sheet.en-us.md Refactor indexer (#25174) 2023-06-23 12:37:56 +00:00
config-cheat-sheet.zh-cn.md Fix all possible setting error related storages and added some tests (#23911) 2023-06-14 11:42:38 +08:00
customizing-gitea.en-us.md Support changing git config through app.ini, use diff.algorithm=histogram by default (#24860) 2023-05-23 16:30:19 +00:00
customizing-gitea.zh-cn.md Change branch name from master to main in some documents' links (#25126) 2023-06-08 07:35:55 +00:00
email-setup.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
email-setup.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
environment-variables.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
environment-variables.zh-cn.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
external-renderers.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
external-renderers.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
fail2ban-setup.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
fail2ban-setup.zh-cn.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
git-lfs-support.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
git-lfs-support.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
https-support.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
https-support.zh-cn.md Remove unnecessary usage prefix from doc titles (#24869) 2023-05-23 18:14:57 +08:00
logging-config.en-us.md Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
logging-config.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
mail-templates.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
mail-templates.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
repo-indexer.en-us.md Rewrite queue (#24505) 2023-05-08 19:49:59 +08:00
repo-indexer.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
reverse-proxies.en-us.md Remove reference to caddy v1 in docs (#24962) 2023-05-28 08:39:16 +00:00
reverse-proxies.zh-cn.md Remove unnecessary usage prefix from doc titles (#24869) 2023-05-23 18:14:57 +08:00
search-engines-indexation.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
search-engines-indexation.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
signing.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
signing.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00