fix: devcontainer

Devcontainer json was wrong in my last update. For some reason vscode was fine with it and actioned it. Add the port numbers for devcontainer too, appPort is the only one that works with the CLI. Added some more docs for devcontainer including the CLI Signed-off-by: Alan Clucas <[email protected]>
argoproj · Jun 2, 2023 · 8baa3fe · 8baa3fe
1 parent 58793a8
commit 8baa3fe
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 10 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -1,5 +1,6 @@
 {
   "image": "mcr.microsoft.com/vscode/devcontainers/base:ubuntu",
+  "appPort": 8080,
   "features": {
     "ghcr.io/devcontainers/features/go:1": {
       "version": "1.20"
@@ -10,14 +11,15 @@
     "ghcr.io/devcontainers/features/docker-in-docker:2": {},
     "ghcr.io/devcontainers/features/python:1": {}
   },
+  "forwardPorts": [9000, 9090, 2746, 8080],
   "hostRequirements": {
     "cpus": 4
   },
   "onCreateCommand": ".devcontainer/pre-build.sh",
   "workspaceMount": "source=${localWorkspaceFolder},target=/home/vscode/go/src/github.com/argoproj/argo-workflows,type=bind",
-  "workspaceFolder": "/home/vscode/go/src/github.com/argoproj/argo-workflows"
+  "workspaceFolder": "/home/vscode/go/src/github.com/argoproj/argo-workflows",
   "remoteEnv": {
-	"PATH": "${containerEnv:PATH}:/home/vscode/go/bin",
-    "GOPATH": "/home/vscode/go"
+    "PATH": "${containerEnv:PATH}:/home/vscode/go/bin",
+    "GOPATH": "${containerEnv:HOME}/go"
   }
 }
diff --git a/Makefile b/Makefile
@@ -654,7 +654,7 @@ docs: /usr/local/bin/mkdocs \
 	# fix the fields.md document
 	go run -tags fields ./hack parseexamples
 	# tell the user the fastest way to edit docs
-	@echo "ℹ️ If you want to preview you docs, open site/index.html. If you want to edit them with hot-reload, run 'make docs-serve' to start mkdocs on port 8000"
+	@echo "ℹ️ If you want to preview your docs, open site/index.html. If you want to edit them with hot-reload, run 'make docs-serve' to start mkdocs on port 8000"
 
 .PHONY: docs-serve
 docs-serve: docs

diff --git a/docs/running-locally.md b/docs/running-locally.md
@@ -2,7 +2,7 @@
 
 You have two options:
 
-1. If you're using VSCode, you use the [Dev-Container](#development-container). This takes about 7 minutes.
+1. If you're using VSCode, you use the [Dev-Container](#development-container). This takes about 7 minutes. This can also be used from the dev-container CLI.
 1. Install the [requirements](#requirements) on your computer manually. This takes about 1 hour.
 
 ## Git Clone
@@ -12,14 +12,17 @@ generation does not work.
 
 ## Development Container
 
-A development container is a running Docker container with a well-defined tool/runtime stack and its prerequisites.
-[The Visual Studio Code Remote - Containers](https://code.visualstudio.com/docs/remote/containers)  extension lets you use a Docker container as a full-featured development environment.
+A development container is a running Docker container with a well-defined tool/runtime stack and its prerequisites. It should be able to do everything you need to do to develop argo workflows using the development container without installing tools on your local machine. It takes quite a long time to build the container. It will run k3d inside the container so you'll have a cluster to use to test against.
 
-System requirements can be found [here](https://code.visualstudio.com/docs/remote/containers#_system-requirements)
+You can use the development container in a few different ways:
+
+1. [Visual studio code](https://code.visualstudio.com/) with [The Visual Studio Code Remote - Containers](https://code.visualstudio.com/docs/remote/containers) extension lets you use a Docker container as a full-featured development environment. Open the clone of argo-workflows folder in VS code and it should offer to use the development container automatically. System requirements can be found [here](https://code.visualstudio.com/docs/remote/containers#_system-requirements). Visual Studio will allow you to forward ports to allow your external browser to access the running components.
+1. [Dev-container CLI](https://code.visualstudio.com/). Install the tool and from the argo-workflow folder do `devcontainer up --workspace-folder .` followed by `devcontainer exec --workspace-folder . /bin/bash` to get a shell where you can start building the code. You can use your choice editor outside the docker image to edit code, the changes are mirrored inside the container. Due to a limitation in the CLI only port 8080 (the Web UI) will get exposed for you to access if you run this way. Other services are usable from the shell inside.
+
+`Github Codespaces` is known not to work at this time.
 
 Note:
 
-* `GOPATH` must be `$HOME/go`.
 * for **Apple Silicon**
     * This platform can spend 3 times the indicated time
     * Configure Docker Desktop to use BuildKit:
@@ -34,10 +37,12 @@ Note:
     * Configure [`.wslconfig`](https://docs.microsoft.com/en-us/windows/wsl/wsl-config#configuration-setting-for-wslconfig) to limit memory usage by the WSL2 to prevent VSCode OOM.
 
 * For **Linux**
-    * Use [Docker Desktop](https://docs.docker.com/desktop/linux/install/) instead of [Docker Engine](https://docs.docker.com/engine/install/) to prevent incorrect network configuration by k3d
+    * Use [Docker Desktop](https://docs.docker.com/desktop/linux/install/) instead of [Docker Engine](https://docs.docker.com/engine/install/) to prevent incorrect network configuration by k3d.
 
 ## Requirements
 
+To build on your own machine without using the dev-container you will need
+
 * [Go](https://golang.org/dl/)
 * [Yarn](https://classic.yarnpkg.com/en/docs/install/#mac-stable)
 * [Docker](https://docs.docker.com/get-docker/)