Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Non root devcontainer #458

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Non root devcontainer #458

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8efc661
refactor(devcontainer): use non absolute path in PROMPT
texhnolyze May 16, 2024
72c401f
feat(devcontainer): use non root user `bitbots`
texhnolyze May 16, 2024
89cb2ad
fix(devcontainer): delete `users` group from container
texhnolyze Jun 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions .devcontainer/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
FROM ros:iron

ARG user=bitbots
ARG uid=1000
ARG gid=1000

# Basic Utilities
ENV DEBIAN_FRONTEND=noninteractive
RUN apt-get update -y \
Expand Down Expand Up @@ -78,18 +82,29 @@ RUN python3 -m pip install \
# Set zsh as default shell
SHELL ["/bin/zsh", "-c"]

# Create home directory and colcon workspace
RUN mkdir -p "/root/colcon_ws"
# Remove the users group, because when it exists on the host system
# the devcontainer will not dynamically update the containerUser GID,
# when the host user is part of the users group.
# Then create a bitbots user with home directory and add allow it to use sudo
RUN groupdel users \
&& useradd -m -U -u "$uid" -G sudo -s /bin/zsh $user \
&& groupmod -g "$gid" $user \
&& echo "$user ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers

Comment on lines +85 to +93
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Potential issues with setting SHELL to zsh affecting RUN commands

Setting the SHELL to /bin/zsh -c earlier in the Dockerfile impacts all subsequent RUN commands. Since zsh syntax differs from sh/bash, this might cause compatibility issues with scripts or commands that assume a sh-compatible shell. Additionally, static analysis tools like Hadolint and ShellCheck may report errors, as they may not fully support zsh, leading to messages like "ShellCheck only supports sh/bash/dash/ksh scripts."

Consider keeping the default SHELL for RUN commands as /bin/sh -c or /bin/bash -c to maintain compatibility and allow static analysis tools to function properly. You can set the default shell for the new user to zsh using the -s /bin/zsh option in useradd, which you've already done.

Apply the following changes:

# Remove or modify the SHELL command to use sh or bash
- SHELL ["/bin/zsh", "-c"]
+ SHELL ["/bin/bash", "-c"]

Committable suggestion was skipped due to low confidence.

🧰 Tools
🪛 Hadolint

[error] 89-89: ShellCheck only supports sh/bash/dash/ksh scripts. Sorry!

(SC1071)

USER $user

# Create colcon workspace
RUN mkdir -p /home/$user/colcon_ws/src

# Install oh-my-zsh for pretty terminal
RUN sh -c "$(wget -O- https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" && \
git clone https://github.com/zsh-users/zsh-autosuggestions ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-autosuggestions
git clone https://github.com/zsh-users/zsh-autosuggestions "${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/plugins/zsh-autosuggestions"

# Add zshrc
COPY zshrc "/root/.zshrc"
# Add zshrc to bitbots home directory
COPY --chown=$user:$user zshrc /home/$user/.zshrc

# This is required for sharing Xauthority
ENV QT_X11_NO_MITSHM=1

# Switch to the workspace directory
WORKDIR "/root/colcon_ws"
WORKDIR /home/$user/colcon_ws
4 changes: 2 additions & 2 deletions .devcontainer/devcontainer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
}
},

"workspaceMount": "type=bind,source=${localWorkspaceFolder},target=/root/colcon_ws/src/bitbots_main",
"workspaceFolder": "/root/colcon_ws/src/bitbots_main",
"workspaceMount": "type=bind,source=${localWorkspaceFolder},target=/home/bitbots/colcon_ws/src/bitbots_main",
"workspaceFolder": "/home/bitbots/colcon_ws/src/bitbots_main",

"mounts": [
"type=bind,source=${localEnv:HOME},target=/srv/host_home,consistency=cached"
Expand Down
2 changes: 1 addition & 1 deletion .devcontainer/zshrc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ bindkey "^[[1;5D" backward-word


# Settings for the prompt to show that we are in a docker container
export PROMPT="%K{black} 🐋 %K{blue}%F{black}%/ %f%k%F{blue}%f " # Prefix the prompt with DOCKER
export PROMPT="%K{black} 🐋 %K{blue}%F{black} %~ %f%k%F{blue}%f " # Prefix the prompt with DOCKER

# >>> bit-bots initialize >>>

Expand Down
Loading