Project

General

Profile

Actions

Bug #23023

closed

Update API docs to mention published_ports[external_port], [base_url], and [initial_path]

Added by Tom Clegg 9 months ago. Updated 8 months ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Target version:
Story points:
-
Release relationship:
Auto

Description

In #22859 we started adding these to each container's published_ports map.

In the meantime you can see #22859#note-3 or source:services/api/app/models/container.rb for the exact fields.
  • initial_url
  • base_url
  • external_port

Subtasks 1 (0 open1 closed)

Task #23070: Review 23023-published-ports-docsResolvedTom Clegg08/06/2025Actions

Related issues 2 (1 open1 closed)

Related to Arvados - Idea #22859: Support service containers on a single hostResolvedTom Clegg06/25/2025Actions
Related to Arvados Epics - Idea #17207: services running in containersIn Progress03/01/202508/31/2025Actions
Actions #1

Updated by Tom Clegg 9 months ago

  • Related to Idea #22859: Support service containers on a single host added
Actions #2

Updated by Tom Clegg 9 months ago

  • Related to Idea #17207: services running in containers added
Actions #3

Updated by Tom Clegg 9 months ago

  • Description updated (diff)
Actions #4

Updated by Tom Clegg 9 months ago

  • Description updated (diff)
Actions #5

Updated by Brett Smith 8 months ago

Note this doesn't make sense to do for as long as we do #23062.

Actions #6

Updated by Brett Smith 8 months ago

  • Target version set to Development 2025-08-06
  • Assigned To set to Tom Clegg
Actions #7

Updated by Brett Smith 8 months ago

  • Subtask #23070 added
Actions #8

Updated by Tom Clegg 8 months ago

  • Status changed from New to In Progress

23023-published-ports-docs @ d0e6de9e2040d6c603a16fe33c0b01cc4a2bbdda -- developer-run-tests: #4840

  • update docs
Actions #9

Updated by Brett Smith 8 months ago

Tom Clegg wrote in #note-8:

23023-published-ports-docs @ d0e6de9e2040d6c603a16fe33c0b01cc4a2bbdda -- developer-run-tests: #4840

One readability nit: for the container example, I think it would be helpful to underline again that these fields only appear on running containers. I know it's mentioned above the table, but since this is reference documentation readers will probably skim for the thing that looks most helpful to them and may not read it all the way through. And while we're at it, this is even less pressing but I don't think we should relegate "(container request)" and "(container)" to parentheticals since they're pretty critical information. Suggest: "Example published_ports attribute for a container request" and "Example published_ports attribute for a running container," but I'm open to further wordsmithing.

This is not critical. Please merge whether you take this verbatim, with tweaks, or would rather not. Thanks.

Actions #10

Updated by Tom Clegg 8 months ago

  • Status changed from In Progress to Resolved
Actions

Also available in: Atom PDF