feat(dev): add development container configuration (#54) #62

Sozhan308 · 2025-02-06T19:01:39Z

Add Development Container Configuration (#54)

Overview

This PR introduces devcontainer setup configurations. The configuration includes necessary tools, dependencies, and post-setup scripts for Go and Node.js development.

Changes

Added Development Container Config Files

Dockerfile : Sets up Ubuntu-based development environment with:
- Go development tools
- Node.js and npm
- Google Cloud SDK and kubectl
- User permissions and workspace setup
docker-compose.yml : Configures:
- Volume mounts for source code and caches
- Build arguments and environment variables
- Docker socket access for container operations
- Network and security settings
setup-dev.sh : Post-creation setup script that:
- Verifies required tool installations
- Sets up Go development environment
- Configures npm and Angular CLI
- Sets Git configurations

Testing

Verified the following tools inside the devcontainer

go version
node --version
npm --version
ng --version
gcloud --version
kubectl version --client

Notes

Requires Docker and Docker Compose
Initial container build may take 3-4 minutes

…rm#54) - Add Dockerfile with Go and Node.js development environment - Configure docker-compose.yml with volume mounts and caching - Create setup-dev.sh for post-container initialization - Set up Git, Go, and Node.js development tools - Add environment variables and user configurations - Configure npm global package handling - Implement tool verification and error handling This change introduces containerized development environment for consistent development across different machines.

…m#54) - Add quick start instructions for VS Code and other IDEs - Include container verification steps

kyasbal

Thank you for contributing our code base!

I haven't tried around .devcontainer for a while, but I learnt how this is well configured and make new contributors easy to start contributes. I think @RyuSA will also comment on this because he should be familiar with around this.

I added some comments. We are open to improve, thus please feel free to reply these suggestions if you have better solution rather than my suggestion.

Thanks! 👍

.devcontainer/DockerFile

.devcontainer/docker-compose.yml

.devcontainer/setup-check.sh

.devcontainer/setup-dev.sh

kyasbal · 2025-02-07T01:27:00Z

And we need to add a license headers in the following scripts.

.devcontainer/docker-compose.yml
.devcontainer/DockerFile
.devcontainer/setup-dev.sh
.devcontainer/setup-check.sh

You can add this just by running make add-licenses
Ref:

khi/scripts/make/codegen.mk

Lines 21 to 22 in 737a2f8

    
           add-licenses: 
        
           	$(GOPATH)/bin/addlicense  -c "Google LLC" -l apache .

…oogleCloudPlatform#54) - Add hash verification for tool installations - Support AMD64/ARM64 architectures for Node.js - Fix npm global permissions and caching - Improve build configuration and cleanup

kyasbal

I tested it on my newly setup Linux VM. It worked after configuring user id or group id environment variables as I pointed out in a review comment.

This devcontainer is very easy setup and so useful!

kyasbal · 2025-02-09T01:17:49Z

.devcontainer/docker-compose.yml

+        USER_UID: ${USER_UID:-1000}
+        USER_GID: ${USER_GID:-1000}


I wonder how these are common to have in environment variables.
I tested this with a new Debian environment just with a docker command. $USER_UID and $USER_GID don't exist but $USERNAME exists.

This seems to cause file permission error on setup-dev.sh L25 because these folder is hold by UID 1000, but VSCode seems to pass the right UID to connect the container.
It works if I set these outside of the container and we can document it, but do you have any better solution?

Now, I've introduced a different approach 7df77f0 for the user handling to work better across different environments:

Made the GID allocation dynamic:

Uses next available GID incase of system group conflicts (like GID 20 for 'dialout')

Preserves specified GID when no conflicts exist

User setup is now more robust:

Used POSIX-standard id command for detection and UID/GID fallbacks in Dockerfile (UID/GID 1000)

Should ideally work with VSCode and other environments

I have tested and it's working. Let me know your thoughts on this!

NOTE: This must be run as a non-root user. Running as root (UID 0) is not supported and will fail with an error.

.devcontainer/docker-compose.yml

.devcontainer/Dockerfile

…dPlatform#54) - Add support for large UIDs in container user creation - Fix user group handling when GID conflicts with system groups - Update environment variable management in setup script

kyasbal

Looks everything good except a thing.
The .env generated in .devcontainer after the build seems not to be ignored in .gitignore.

If I understand this change correctly, that should be ignored, shouldn't it? I'm gonna approve this PR once this concern is solved.

Sozhan308 · 2025-02-09T17:20:50Z

Looks everything good except a thing. The .env generated in .devcontainer after the build seems not to be ignored in .gitignore.

If I understand this change correctly, that should be ignored, shouldn't it? I'm gonna approve this PR once this concern is solved.

Yep, 👍 I'll add it

kyasbal

Looks awesome! Thank you a lot for your contribution 🎉 🎉 🎉

Sozhan308 force-pushed the setup-devcontainer-configuration-#54 branch from 86a1f24 to f53db3b Compare February 6, 2025 19:37

Sozhan308 added 2 commits February 7, 2025 01:24

docs(dev): add devcontainer setup and usage guide (GoogleCloudPlatfor…

6e3cae9

…m#54) - Add quick start instructions for VS Code and other IDEs - Include container verification steps

Sozhan308 force-pushed the setup-devcontainer-configuration-#54 branch from f53db3b to 6e3cae9 Compare February 6, 2025 19:54

kyasbal requested changes Feb 7, 2025

View reviewed changes

kyasbal requested a review from RyuSA February 7, 2025 01:27

refactor: enhance dev container with security and multi-arch support (G…

e9911cf

…oogleCloudPlatform#54) - Add hash verification for tool installations - Support AMD64/ARM64 architectures for Node.js - Fix npm global permissions and caching - Improve build configuration and cleanup

Sozhan308 force-pushed the setup-devcontainer-configuration-#54 branch from 90b5e6b to e9911cf Compare February 8, 2025 19:52

kyasbal requested changes Feb 9, 2025

View reviewed changes

fix: improve devcontainer user handling and configuration (GoogleClou…

7df77f0

…dPlatform#54) - Add support for large UIDs in container user creation - Fix user group handling when GID conflicts with system groups - Update environment variable management in setup script

Sozhan308 force-pushed the setup-devcontainer-configuration-#54 branch from c1a6a47 to 7df77f0 Compare February 9, 2025 09:25

kyasbal requested changes Feb 9, 2025

View reviewed changes

chore: add devcontainer env file to gitignore (GoogleCloudPlatform#54)

592a14b

kyasbal approved these changes Feb 10, 2025

View reviewed changes

kyasbal merged commit 0dbe123 into GoogleCloudPlatform:main Feb 10, 2025
6 checks passed

kyasbal linked an issue Feb 10, 2025 that may be closed by this pull request

Setup .devcontainer #54

Closed

kyasbal mentioned this pull request Feb 10, 2025

Setup .devcontainer #54

Closed

feat(dev): add development container configuration (#54) #62

feat(dev): add development container configuration (#54) #62

Uh oh!

Conversation

Sozhan308 commented Feb 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Add Development Container Configuration (#54)

Overview

Changes

Added Development Container Config Files

Testing

Notes

Uh oh!

kyasbal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kyasbal commented Feb 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kyasbal left a comment

Choose a reason for hiding this comment

Uh oh!

kyasbal Feb 9, 2025

Choose a reason for hiding this comment

Uh oh!

Sozhan308 Feb 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kyasbal left a comment

Choose a reason for hiding this comment

Uh oh!

Sozhan308 commented Feb 9, 2025

Uh oh!

kyasbal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Sozhan308 commented Feb 6, 2025 •

edited

Loading

kyasbal commented Feb 7, 2025 •

edited

Loading

Sozhan308 Feb 9, 2025 •

edited

Loading