[WIP][CI:DOCS]Add DevContainers Documentation

[jakecorrenti]

Added documentation for setting up DevContainers in Visual Studio Code using Podman instead of Docker.

Adapted from the work done in #15254

Does this PR introduce a user-facing change?

None

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: jakecorrenti
Once this PR has been reviewed and has the lgtm label, please assign giuseppe for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[jakecorrenti]

Basic use cases are reproducible. However, I need to iron out some edge cases with more complex use cases.

[TomSweeneyRedHat]

I'm assuming it has to be a Dockerfile vs a Containerfile

[jakecorrenti]

confirmed that Containerfile does work

[TomSweeneyRedHat]

Just a quick late day review, and it looks really good overall. It would be awesome of you could walk through this in a Gmeet, save the recording, then give me a ptr to it so I could put it up on the YouTube channel.

[jakecorrenti]

I could definitely put that together for you

[fulldecent]

I followed along on a M1 MacBook Pro. I kept the uid=1000 part and did not know if I needed to change that.

Also I needed to add a podman machine start.

End result is this error:

[fulldecent]

I see the instructions are updated. I followed them, instead using my actual user name instead of $USER in the env variable.

Now got further to this error message:

[62455 ms] Start: Run in container: mkdir -p '/root/.vscode-server/bin' && ln -snf '/vscode/vscode-server/bin/linux-arm64/b3e4e68a0bc097f0ae7907b217c1119af9e03435' '/root/.vscode-server/bin/b3e4e68a0bc097f0ae7907b217c1119af9e03435'
[62473 ms] 
[62473 ms] mkdir: cannot create directory ‘/root’: Permission denied
[62473 ms] Exit code 1
[62475 ms] Command in container failed: mkdir -p '/root/.vscode-server/bin' && ln -snf '/vscode/vscode-server/bin/linux-arm64/b3e4e68a0bc097f0ae7907b217c1119af9e03435' '/root/.vscode-server/bin/b3e4e68a0bc097f0ae7907b217c1119af9e03435'
[62475 ms] mkdir: cannot create directory ‘/root’: Permission denied
[62475 ms] Exit code 1

[jakecorrenti]

@fulldecent what Image did you select? And what does your devcontainer.json file look like

[fulldecent]

@jakecorrenti I used the Ubuntu image.

And here is the file

// Documentation:
//  - https://github.com/devcontainers/images/tree/main/src/jekyll
//  - https://github.com/devcontainers/features/tree/main/src/node
//  - https://github.com/devcontainers/features/tree/main/src/php

// Issue: how to remove the github.copilot dependency?
// https://stackoverflow.com/questions/76037936/how-to-load-github-copilot-without-specifying-in-devcontainer-json
{
    "name": "Jekyll",
    "image": "mcr.microsoft.com/devcontainers/jekyll",
    "features": {
      // Install latest stable Node (we use for validation scripts after build)
      "ghcr.io/devcontainers/features/node:1": {
        "version": "lts"
      }
    },
    "customizations": {
      "vscode": {
        "extensions": ["github.copilot", "html-validate.vscode-html-validate"]
      }
    }
}

[jakecorrenti]

@jakecorrenti I used the Ubuntu image.

And here is the file

// Documentation:
//  - https://github.com/devcontainers/images/tree/main/src/jekyll
//  - https://github.com/devcontainers/features/tree/main/src/node
//  - https://github.com/devcontainers/features/tree/main/src/php

// Issue: how to remove the github.copilot dependency?
// https://stackoverflow.com/questions/76037936/how-to-load-github-copilot-without-specifying-in-devcontainer-json
{
    "name": "Jekyll",
    "image": "mcr.microsoft.com/devcontainers/jekyll",
    "features": {
      // Install latest stable Node (we use for validation scripts after build)
      "ghcr.io/devcontainers/features/node:1": {
        "version": "lts"
      }
    },
    "customizations": {
      "vscode": {
        "extensions": ["github.copilot", "html-validate.vscode-html-validate"]
      }
    }
}

Using the "features" functionality is known to lead to bugs (#17313). Investigating.

[github-actions]

A friendly reminder that this PR had no activity for 30 days.

[vrothberg]

Closing the PR due to inactivity. Feel free to reopen.