Skip to content

[CHORE] Rename all UnravelDocs/unraveldocs identifiers in docker-compose.yml #199

@aniebietafia

Description

@aniebietafia

Problem

docker-compose.yml is saturated with the old brand identity across service names, container names, network definitions, and environment variable defaults:

Element Current Value
Service name unraveldocs-api
Container name unraveldocs-api
POSTGRES_DB default unraveldocs
Postgres healthcheck DB unraveldocs
Elasticsearch cluster.name unraveldocs-cluster
Elasticsearch node.name unraveldocs-node
Docker network unraveldocs-net

This means docker-compose up starts a container named unraveldocs-api, connects to a database named unraveldocs, and registers an Elasticsearch cluster named unraveldocs-cluster. All three contradict the new brand.

Proposed Solution

Replace all occurrences with xtraction equivalents throughout docker-compose.yml.

User Stories

  • As a developer running the local stack, I want Docker container names, network names, and service identifiers to reflect xtraction so I can easily identify running services.
  • As a DevOps engineer, I want Elasticsearch cluster and node names to use the new brand for correct identification in monitoring tools like Kibana and Datadog.

Acceptance Criteria

  • Service name is xtraction-api
  • Container name is xtraction-api
  • POSTGRES_DB default is xtraction
  • Postgres healthcheck references xtraction DB
  • Elasticsearch cluster.name=xtraction-cluster
  • Elasticsearch node.name=xtraction-node
  • Docker network is xtraction-net
  • grep -i "unraveldocs" docker-compose.yml returns zero results
  • docker-compose up -d starts all services cleanly

Proposed Technical Details

# Before
services:
  unraveldocs-api:
    container_name: unraveldocs-api
    ...
networks:
  unraveldocs-net:

# After
services:
  xtraction-api:
    container_name: xtraction-api
    ...
networks:
  xtraction-net:

Each service's networks reference must also be updated from unraveldocs-net to xtraction-net.

Tasks

  • Rename service unraveldocs-apixtraction-api
  • Update container_namextraction-api
  • Update POSTGRES_DB default → xtraction
  • Update Postgres healthcheck DB name
  • Update Elasticsearch cluster.name and node.name
  • Rename network unraveldocs-netxtraction-net
  • Update all networks: references in every service block
  • Run docker-compose up -d and verify all containers start
  • Run docker ps and confirm container names

Open Questions / Considerations

  • Existing Docker volumes (e.g., postgres_data) may contain data from the unraveldocs database. Developers running persistent volumes need to either drop and recreate them or run a database rename. Add a migration note to the PR description.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions