Convert into Dev Container feature #6

zombiezen · 2022-12-07T17:06:04Z

I've QA'd this manually and was able to connect to my Tailnet.

Unfortunately, I couldn't get the tailscale up to work as nicely in this model because the entrypoint does not have access to the Codespaces secrets. OTOH, this is now a one-time inconvenience and allows the user to go through the interactive login flow rather than always having to generate a key, since the state is persisted.

I was also dismayed that the user has to add runArgs, but the Dev Container spec does not include a metadata key for that. The spec is still evolving and it's probably just an oversight, so I've opened devcontainers/spec#153 to see if we can get that fixed.

I added a GitHub Actions workflow to publish the feature to GitHub Container Registry. The preferred distribution mechanism for Dev Container features is Docker images, but it doesn't matter what registry you use if you want to host elsewhere. I wasn't able to test the image deployment, so you may need to hack on it a little bit to get it to work. LMK if I can help.

Fixes #5

Fixes tailscale#5

zombiezen · 2022-12-07T17:15:03Z

@DentonGentry Would you be able to review this (or find someone who could)? I think this would simplify the Tailscale experience on GitHub Codespaces pretty dramatically. You would also need to update https://tailscale.com/kb/1160/github-codespaces/ with the new instructions: I've updated the README with the basic gist and some supporting links to assist.

domkm · 2022-12-08T23:31:34Z

@zombiezen This looks very useful. How would one use it prior to Tailscale merging this PR? I attempted to publish it but the Action failed with:

[2022-12-08T23:26:08.714Z] (!) ERR: Failed to fetch devcontainer-collection.json
Error: The process '/usr/local/bin/devcontainer' failed with exit code 1
Error: (!) Failed to publish features.

zombiezen · 2022-12-09T01:51:39Z

I tested locally by copying the tailscale feature directory to .devcontainer/tailscale and adding to the devcontainer.json file:

"runArgs": ["--device=/dev/net/tun"],
"features": {
  // ...
  "./tailscale": {}
  // ...
}

domkm · 2022-12-09T18:13:44Z

@zombiezen Thanks. That built successfully but running sudo tailscale up --netfilter-mode=off or tailscale up errors with failed to connect to local tailscaled; it doesn't appear to be running (sudo systemctl start tailscaled ?). Running sudo systemctl start tailscaled errors with sudo: systemctl: command not found.

EDIT: Also, sudo tailscaled errors with getLocalBackend error: createEngine: tstun.New("tailscale0"): CreateTUN("tailscale0") failed; /dev/net/tun does not exist despite "runArgs": ["--device=/dev/net/tun"].

EDIT: Following this seems to fix the issue running sudo tailscaled.

zombiezen · 2022-12-09T22:18:49Z

@domkm Was this running on GitHub Codespaces or on your local machine? Can you post both the devcontainer.json file and the content of the container file /tmp/tailscaled.log?

domkm · 2022-12-09T22:29:43Z

@zombiezen Codespaces.

Here is likely the most relevant part of devcontainer.json:

  "dockerComposeFile": "../docker-compose.yml",
  "service": "devcontainer",
  "workspaceFolder": "/app/",
  "overrideCommand": true,
  "postStartCommand": "cp --update /opt/build/poetry/poetry.lock /app/ && mkdir -p /app/.git/hooks/ && cp --update /opt/build/git/* /app/.git/hooks/",
  "runArgs": ["--device=/dev/net/tun"],
  "features": {
    "./tailscale": {}
  },

You'd need at least the full devcontainer.json, Dockerfile, and docker-compose.yml to replicate it exactly, which will get unwieldy here because GitHub doesn't support attachments. However, it was set up with https://github.com/radix-ai/poetry-cookiecutter, so you should be able to generate the same code easily.

cat /tmp/tailscaled.log
cat: /tmp/tailscaled.log: No such file or directory

zombiezen · 2022-12-09T22:37:53Z

What's the base distribution for the container image? And is there anything relevant in the container file /workspaces/.codespaces/.persistedshare/creation.log?

If nothing else, I'm suspecting that overrideCommand is preventing the entrypoint from starting tailscaled automatically.

domkm · 2022-12-09T22:43:07Z

python:3.11-slim

I see a few error exits in /workspaces/.codespaces/.persistedshare/creation.log:

2022-12-09 21:35:01.936Z: $ /usr/bin/zsh -lic echo -n 5b0d7170f4e1fc937c32b6b7953535a1; cat /proc/self/environ; echo -n 5b0d7170f4e1fc937c32b6b7953535a1
2022-12-09 21:35:01.936Z: 
2022-12-09 21:35:01.936Z: 
2022-12-09 21:35:01.936Z: Exit code 1
2022-12-09 21:35:01.936Z: && echo '2022-12-09T18:07:08.51809921Z' > '/home/app/.vscode-remote/data/Machine/.onCreateCommandMarker'
2022-12-09 21:35:01.936Z: $08.51809921Z' > '/home/app/.vscode-remote/data/Machine/.updateContentCommandMarker'
2022-12-09 21:35:01.936Z: 
2022-12-09 21:35:01.936Z: 
2022-12-09 21:35:01.936Z: Exit code 1
2022-12-09 21:35:01.936Z: && echo '2022-12-09T18:07:08.51809921Z' > '/home/app/.vscode-remote/data/Machine/.updateContentCommandMarker'
2022-12-09 21:35:01.936Z: $08.51809921Z' > '/home/app/.vscode-remote/data/Machine/.postCreateCommandMarker'
2022-12-09 21:35:01.936Z: 
2022-12-09 21:35:01.936Z: 
2022-12-09 21:35:01.936Z: Exit code 1
2022-12-09 21:35:01.936Z: && echo '2022-12-09T18:07:08.51809921Z' > '/home/app/.vscode-remote/data/Machine/.postCreateCommandMarker'
2022-12-09 21:35:01.936Z: $54.365547483Z' > '/home/app/.vscode-remote/data/Machine/.postStartCommandMarker'
2022-12-09 21:35:01.963Z: 
2022-12-09 21:35:01.963Z: 
2022-12-09 21:35:01.963Z: && echo '2022-12-09T21:34:54.365547483Z' > '/home/app/.vscode-remote/data/Machine/.postStartCommandMarker'
2022-12-09 21:35:01.963Z: Running the postStartCommand from devcontainer.json...
2022-12-09 21:35:01.963Z: 
2022-12-09 21:35:02.215Z: Stop (288 ms): Run in container: /usr/bin/zsh -lic echo -n 5b0d7170f4e1fc937c32b6b7953535a1; cat /proc/self/environ; echo -n 5b0d7170f4e1fc937c32b6b7953535a1
2022-12-09 21:35:02.215Z: userEnvProbe PATHs:
2022-12-09 21:35:02.215Z: Probe:     '/opt/app-env/bin:/usr/local/bin:/usr/local/sbin:/usr/sbin:/usr/bin:/sbin:/bin:/home/app/.antigen/bundles/zsh-users/zsh-syntax-highlighting:/home/app/.antigen/bundles/zsh-users/zsh-autosuggestions'
2022-12-09 21:35:02.215Z: Container: '/opt/app-env/bin:/usr/local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin'
2022-12-09 21:35:02.215Z: $ /bin/sh -c cp --update /opt/build/poetry/poetry.lock /app/ && mkdir -p /app/.git/hooks/ && cp --update /opt/build/git/* /app/.git/hooks/
2022-12-09 21:35:02.299Z: Stop (95 ms): Run in container: /bin/sh -c cp --update /opt/build/poetry/poetry.lock /app/ && mkdir -p /app/.git/hooks/ && cp --update /opt/build/git/* /app/.git/hooks/

zombiezen · 2022-12-10T01:27:04Z

Really seems like the entry point isn't getting called. Try removing the overrideCmd from your devcontainer.json.

DentonGentry · 2022-12-10T19:34:40Z

README.md

+Then launch your Codespace. After it starts up, run [`tailscale up`](https://tailscale.com/kb/1080/cli/#up):
+
+```shell
+sudo tailscale up --netfilter-mode=off


Could I ask why it sets --netfilter-mode=off? I wouldn't expect to need this in codespaces.

I'll defer to you: I was cargo-culting from 94af521 Removed for now, since I was able to QA without it and it seemed to work.

tailscale/tailscaled-entrypoint.sh

README.md

DentonGentry · 2022-12-10T22:47:53Z

tailscale/install.sh

+script_dir="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+scratch_dir="/tmp/tailscale"
+mkdir -p "$scratch_dir"
+trap 'rm -rf "$scratch_dir"' EXIT


I don't understand this line: it seems like it deletes the /tmp/tailscale directory which the previous line should have just created.

trap ... EXIT can be thought of like a defer in Go. It runs a command once the shell exits. More docs here: https://tldp.org/LDP/Bash-Beginners-Guide/html/sect_12_02.html

nikolarobottesla · 2023-01-01T14:28:42Z

FYI, This branch worked for me without issue. (once I added curl to my container)

I used the method described here: #6 (comment)

devcontainer.json

{
    "name": "Tailscale-Ansible Codespace",
    "dockerFile": "Dockerfile",
    "context": "..",
    "runArgs": ["--device=/dev/net/tun"],
    "features": {
    "./tailscale": {}
    }
}

Dockerfile

FROM ubuntu:latest
RUN apt-get update && apt-get install -y curl gpg dnsutils git python3 python3-pip
RUN pip3 install ansible

DentonGentry

I think this is good. I'll merge it when a PR for the knowledgebase article is ready to merge along with it.

mayakacz · 2023-01-03T19:56:46Z

Updates devcontainers/devcontainers.github.io#119

Convert into Dev Container feature

cb08026

Fixes tailscale#5

zombiezen mentioned this pull request Dec 7, 2022

Add support for devices in devcontainer-feature.json devcontainers/spec#153

Open

DentonGentry reviewed Dec 10, 2022

View reviewed changes

zombiezen added 3 commits December 12, 2022 11:30

Redirect tailscaled log to /dev/null

d22a45b

Use --statedir instead of --state

3460d70

Updated tailscale up command

8a07ef6

zombiezen requested a review from DentonGentry December 15, 2022 05:30

Revert accidental removal

7b25232

DentonGentry approved these changes Jan 1, 2023

View reviewed changes

DentonGentry merged commit 36ff242 into tailscale:main Jan 4, 2023

Convert into Dev Container feature #6

Convert into Dev Container feature #6

Uh oh!

Conversation

zombiezen commented Dec 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zombiezen commented Dec 7, 2022

Uh oh!

domkm commented Dec 8, 2022

Uh oh!

zombiezen commented Dec 9, 2022

Uh oh!

domkm commented Dec 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zombiezen commented Dec 9, 2022

Uh oh!

domkm commented Dec 9, 2022

Uh oh!

zombiezen commented Dec 9, 2022

Uh oh!

domkm commented Dec 9, 2022

Uh oh!

zombiezen commented Dec 10, 2022

Uh oh!

DentonGentry Dec 10, 2022

Choose a reason for hiding this comment

Uh oh!

zombiezen Dec 12, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DentonGentry Dec 10, 2022

Choose a reason for hiding this comment

Uh oh!

zombiezen Dec 12, 2022

Choose a reason for hiding this comment

Uh oh!

nikolarobottesla commented Jan 1, 2023

Uh oh!

DentonGentry left a comment

Choose a reason for hiding this comment

Uh oh!

mayakacz commented Jan 3, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

zombiezen commented Dec 7, 2022 •

edited

Loading

domkm commented Dec 9, 2022 •

edited

Loading