Skip to content

Indexer: README install section and release notes for the new indexer #107

Open

Description

@johnf

Parent

Spec: indexer redesign

What to build

The documentation for going live with the new indexer on a fresh VM.

  • README install section:
    1. Migrate the database (pnpm db:deploy).
    2. Put the crates in the repository.
    3. Start the API and the worker.
    4. Ask for every crate to be indexed (CLI or admin pages).
    5. Switch traffic once the admin crates page shows every crate as indexed and none failed.
  • README: describes the worker, the index states and running more than one worker.
  • Release notes: "rebuild both indexes after upgrading" (run pnpm db:deploy, delete the search index, index again). There's no upgrade path for existing data.
  • Known limits:
    • there's no no-gap rebuild
    • a search mapping change needs a maintenance window
    • text past 1 MB isn't searchable
    • a changed parent crate leaves its children stale until they are reindexed

Acceptance criteria

  • Following the README install section on an empty machine gives a working API with every crate indexed.
  • The release notes and known limits are in the README or changelog.

Metadata

Metadata

Assignees

No one assigned

    Labels

    ready-for-agentFully specified, ready for an AFK agent

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions