Page MenuHomePhabricator

[Docs] Document how to build and deploy tunnelbroker
ClosedPublic

Authored by jon on Jun 26 2023, 6:21 AM.
Tags
None
Referenced Files
F2154972: D8312.diff
Sun, Jun 30, 8:19 PM
Unknown Object (File)
Sat, Jun 29, 3:11 AM
Unknown Object (File)
Sat, Jun 29, 3:11 AM
Unknown Object (File)
Sat, Jun 29, 3:11 AM
Unknown Object (File)
Sat, Jun 29, 3:11 AM
Unknown Object (File)
Sat, Jun 29, 3:11 AM
Unknown Object (File)
Sat, Jun 29, 3:05 AM
Unknown Object (File)
Sat, Jun 29, 1:47 AM
Subscribers

Details

Summary

After testing the deployment, document how it was able to be built
and ran.

Part of https://linear.app/comm/issue/ENG-4104

Test Plan

N/A. Documentation

Diff Detail

Repository
rCOMM Comm
Branch
jonringer/build-tunnelbroker-image (branched from master)
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

docs/nix_dev_env.md
132 ↗(On Diff #28112)
docs/nix_services_deployment.md
14 ↗(On Diff #28112)
14 ↗(On Diff #28112)

I mention OCI container (which is probably the more correct way to refer to the image), but name the file docker_image, should i renamed it make_oci_image.sh?

services/tunnelbroker/make_docker_image.sh
19 ↗(On Diff #28112)

This change is to allow for arguments to be passed from the cli to the docker command

docs/nix_services_deployment.md
9 ↗(On Diff #28112)

Also, you should mention that this command should be run from the repository root directory

14 ↗(On Diff #28112)

Despite "OCI image" being more correct, I think the "docker" should stay because it is more recognizable and even people less familiar with containers etc. will know what it is for.

19 ↗(On Diff #28112)
22–26 ↗(On Diff #28112)

I don't like the manual way of providing params here (this is the area where docker-compose is superior) but I'm okay with that for now, we're gonna automate deployments anyway at some point.

ashoat requested changes to this revision.Jun 28 2023, 4:58 PM

Please internalize all of the feedback here so it doesn't have to be repeated in future docs diffs

docs/nix_services_deployment.md
5
9

What is OCI? Why is it referenced here? I have never seen this before. Can you use simpler terminology that doesn't force the reader to Google things?

19
This revision now requires changes to proceed.Jun 28 2023, 4:58 PM
jon marked 7 inline comments as done.

Address feedback

docs/nix_services_deployment.md
9

Docker is more accurate, as we are using docker directly.

When I was doing devops, we would call them OCI images (used podman to build the images).

22–26 ↗(On Diff #28112)

Yea, I hope after your work, this will just be terraform plan && terraform apply

docs/nix_services_deployment.md
9

OCI image is the "Open Cloud Initiative" image.

Essentially a subset of the docker image specification which isn't docker specific. (Think podman)

bartek added inline comments.
docs/nix_services_deployment.md
19 ↗(On Diff #28390)
ashoat added inline comments.
docs/nix_services_deployment.md
19 ↗(On Diff #28390)

I think @bartek is right. Both sound okay to me, but I found this on Reddit

This revision is now accepted and ready to land.Jul 4 2023, 6:35 PM