DefangLabs / DefangLabs/defang

Service names and dns

Open
#654 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
166
Forks
24
Avg merge
10h 8m
Merged PRs (30d)
33

Description

We need to document the fact that service names get converted to kebab-case. My instinct would be to throw an error if they aren't, but I guess that's not necessarily practical.

Right now if someone has postgres_service as a service name, it gets translated into postgres-service in DNS, which makes sense, but they might not be aware of if they're used to the way docker compose works, which allows the underscores. We can do replacement for things that are visible in env in the compose file, but if someone puts that elsewhere, then it won't be automatically replaced (I can imagine a situation where someone has a dev/staging/prod config file and uses env vars to select the file for example)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files or tests. Start by locating the documentation covering service names, DNS naming, and Docker Compose compatibility; document that service names are converted to kebab-case and explain the implications for references outside visible Compose environment values. Done means a reader can understand the conversion and its configuration-file caveat.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker-compose
Domain
documentation, networking
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.