Arvados

Brett Smith wrote:

Maybe we should document a Jupyter notebook instead/in addition to this?

I spent a couple hours trying to get this to work. It does not because the architecture requires clients to be able to connect to the server via websockets. The way controller proxies the connections interferes with this design. See this SO Q&A (as best I can tell it's still accurate today).

23051-service-containers-doc @ 003beaad198e983e82d7d96bdb9bdfd9e6ae574e - developer-run-tests-doc-sdk-java-R: #2252

Note this branch assumes that #22996 is merged, including the reference documentation it adds. If you want to follow along with the CWL example, you'll need to install and run arvados-cwl-runner from that branch.

This branch adds a new page to the user guide that documents the full lifecycle of a service container using nginx as an example. It documents both higher-level and API-based ways to create, connect to, and stop service containers.

• All agreed upon points are implemented / addressed. Describe changes from pre-implementation design.
  • Yes
• Anything not implemented (discovered or discussed during work) has a follow-up story.
  • N/A
• Code is tested and passing, both automated and manual, what manual testing was done is described.
  • Passes full linkcheck per above.
• Tested code incorporates recent main branch changes.
  • Yes
• New or changed UI/UX and has gotten feedback from stakeholders.
  • N/A
• Documentation has been updated.
  • Yes
• Behaves appropriately at the intended scale (describe intended scale).
  • N/A for doc branch
• Considered backwards and forwards compatibility issues between client and server.
  • N/A for doc branch
• Follows our coding standards and GUI style guidelines.
  • N/A for doc branch

A couple of small notes:

• L46 might benefit from having wiki links about "basic data and workflow management in Arvados."
• L289 Running containers can also be stopped in the toolbar, which is shown in the same screenshot. I don't know if that extra info is super useful to the user, but it might be worth adding since it's right there.

Lisa Knox wrote in #note-8:

A couple of small notes:

Both taken plus a typo fix, now at 572a7244da29ed820cb2315a52706093632f2ba1 - developer-run-tests-doc-sdk-java-R: #2253

lgtm