After testing the deployment, document how it was able to be built
and ran.
Details
Details
N/A. Documentation
Diff Detail
Diff Detail
- Repository
- rCOMM Comm
- Lint
Lint Not Applicable - Unit
Tests Not Applicable
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. |
Comment Actions
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 ↗ | (On Diff #28163) | |
| 9 ↗ | (On Diff #28163) | 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 ↗ | (On Diff #28163) | |
Comment Actions
Address feedback
| docs/nix_services_deployment.md | ||
|---|---|---|
| 9 ↗ | (On Diff #28163) | 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 ↗ | (On Diff #28163) | OCI image is the "Open Cloud Initiative" image. Essentially a subset of the docker image specification which isn't docker specific. (Think podman) |
| docs/nix_services_deployment.md | ||
|---|---|---|
| 19 ↗ | (On Diff #28390) | |