Page MenuHomePhabricator

Update the template's configuration documentation
Open, MediumPublic

Description

service-template-node is a template that people use to build micro-services in Node.JS if they intend to deploy them to the WMF production cluster.
Each service is configured using the YAML configuration file.
Specifically, the template mandates that certain configuration options exist in all of the services.

We have some existing configuration documentation, but it is outdated. We need to document all of the configuration options required or supplied by the template, ideally in the form of a table:

NameRequiredDefaultDescription
portno6927the port the service listens on

The documentation should be added directly to the configuration documentation on mediawiki.org. The code that manipulates the shared configuration options is here and here.

Event Timeline

mobrovac created this task.Dec 28 2016, 4:18 PM
Restricted Application added subscribers: TerraCodes, Aklapper. · View Herald TranscriptDec 28 2016, 4:18 PM
AMooney changed the task status from Open to Stalled.Mar 12 2020, 1:22 PM
WDoranWMF moved this task from Inbox to Icebox on the Platform Engineering board.Mar 12 2020, 1:32 PM
Aklapper changed the task status from Stalled to Open.Oct 19 2020, 9:51 AM
Aklapper updated the task description. (Show Details)
Aklapper added a subscriber: AMooney.

@AMooney: The previous comments don't explain who or what (task?) exactly this task is stalled on ("If a report is waiting for further input (e.g. from its reporter or a third party) and can currently not be acted on"). Hence resetting task status.