VeRLab Wiki - User contributions [en]

Docker

2025-04-09T14:41:00Z

Isaacreyes: /* Criar regra udev para dispositivo USB */

== Docker Rootless Mode ==

O modo disponível do Docker para os usuários da rede é o '''Docker Engine no modo Rootless''', ou seja, apenas a versão em linha de comando e no modo de acesso non-root.

Em geral, funciona para todas as aplicações e pode-se ler mais informações no [https://docs.docker.com/engine/security/rootless/ link Docker Rootless]
 
'''Importante''': para estas configurações é necessário que a máquina tenha um docker instalado com versão >= 20.10 (pode ser conferido com: <code>docker version</code>)

Este processo ainda se encontra em uma fase experimental e não está disponível em todas as máquinas. As máquinas disponíveis com docker até o momento são '''PROC1, PROC2, PROC5, PROC6, PROC7, EPONA, NYMERIA, DROGON''', '''EVA, WALL-E, MAGRITTE''' e '''DALEK'''.
 

== Configuração Docker rootless com Systemd (não é possível usar simultaneamente em outras máquinas, apenas em uma máquina da rede por vez) ==

 
A opção mais intuitiva para executar o Docker Rootless é gerenciando pelo '''systemctl --user'''. Porém tem a limitação de '''funcionar em apenas uma máquina da rede por vez''', pois o arquivo que gerencia o systemctl do usuário é salvo na /home que é compartilhada em todas as máquinas, portanto '''apenas um processo docker rootless do usuário pode ser criado, mas em qualquer máquina da rede'''.

=== Pré-requisitos ===
Para utilizar docker rootless em uma máquina no laboratório é preciso que o usuário:

* solicite à equipe de rede para criar uma pasta de rascunho no disco local como /draft-xxx/nome_do_usuario e dar permissão de leitura/escrita.
* solicite à equipe de rede a instalação do docker na máquina.
 

=== Configuração ===
Feito estas etapas, para configurar o acesso na máquina é preciso seguir os seguintes passos para executar o docker rootless:

# Crie a pasta <code>~/.config/docker</code> com o comando <code>mkdir -p ~/.config/docker</code>.
# Altere a pasta de armazenamento dos arquivos de cache do Docker para a pasta de rascunho /draft-xxx com:

<code>echo '{"data-root":"/<path-em-disco-local>/<user>/docker-cache"}' | tee ~/.config/docker/daemon.json</code>
 
'''Importante:''' Lembre-se de ajustar o <code><path-em-disco-local>/<user></code> para uma armazenamento de rascunho na máquina e alguma pasta do seu usuário (por exemplo, <code>/draft-hdd/fulano</code>).
 
Esses dois primeiros passos são específicos para as máquinas do VeRLab: por padrão o Docker guarda arquivos na /home do usuário, mas essa pasta é compartilhada em rede (por NFS ou MooseFS) e o Docker não dá suporte a isso.[https://github.com/docker/for-linux/issues/1172 Aqui está um issue citando o problema]

# Execute <code>dockerd-rootless-setuptool.sh install</code>.
 
'''Importante''': Após terminar, o comando vai pedir que você altere seu .bashrc para adicionar uma linha semelhante a <code>export DOCKER_HOST=unix:///run/user/<uid>/docker.sock</code> (varia por usuário). Faça essa alteração antes de prosseguir copiando e colando o comando no terminal.
# Reinicie o Bash com <code>exec bash</code>.
# Ative a inicialização automática do Docker em seu usuário: <code>systemctl --user enable --now docker</code> ou manualmente: <code>systemctl --user start docker</code>

Com isso, a configuração está pronta!

=== Utilização ===
Comandos para confirmar se o Docker está funcionando:
* Verificar status do docker daemon: <code>systemctl --user status docker.service</code>
* Parar docker daemon: <code>systemctl --user stop docker.service</code>
* Verificar configurações do Docker Rootless: <code>docker version</code> ou <code>docker info</code>
* Baixar uma imagem teste e executá-la: <code>docker run hello-world</code>
 

== Configuração Docker Rootless "Manual" para execução simultânea em várias máquinas da rede ==

 
Essa opção pode parecer menos intuitiva, pois o usuário precisará executar manualmente o '''daemon do docker rootless''' em um terminal e mantê-lo em execução para poder utilizar os comandos docker em outros terminais.

Isso pode ser facilmente feito utilizando os [https://www.verlab.dcc.ufmg.br/mediawiki/index.php/Trabalhando_remotamente#Usando_tmux_ou_byobu:_multiplexador_de_terminais multiplexadores de terminal como tmux ou byobu].

Uma vez que parar a execução do docker daemon com ctrl+c ou fechar o terminal, isso vai "matar" a execução do docker rootless na máquina e parar todos seus containers de forma abrupta. Porém tem a flexibilidade de não precisar da pasta /home para armazenar as configurações do daemon, então com essa configuração é possível executar o docker rootless em várias máquinas simultaneamente!

=== Pré-requisitos ===
Para utilizar Docker Rootless em uma máquina no laboratório é preciso que o usuário:

* solicite à equipe de rede para criar uma pasta de rascunho no disco local como /draft-xxx/nome_do_usuario e dar permissão de leitura/escrita.
* solicite à equipe de rede a instalação do docker na máquina.

=== Configuração ===

# Abra seu arquivo <code>~/.bashrc</code> no editor de texto preferido, se for no terminal pode usar o nano: <code>'''nano ~/.bashrc'''</code>
# Cole as seguintes funções no final desse arquivo e salve o mesmo:

{| class="wikitable"
|-
! Criar arquivo de configuração do tmux para habilitar o mouse e outras coisas úteis
|-
|
<pre>
# Funções para adicionar no final do aquivo ~/.bashrc e usar docker rootless na rede VeRLab/JLab

# Função para criar pastas e configuração do docker rootless
function docker-rootless-create-dir(){
MYUSER=$(whoami)
# Cria environment variables para pastas
echo -e "Exporting Environment Variables for Docker Rootless Create Folder..."
export USER_BASE_DIR=/draft-hdd/${MYUSER} && \
export USER_DOCKER_DIR=$USER_BASE_DIR/docker-rootless &&\
echo -e " USER_BASE_DIR=$USER_BASE_DIR\n USER_DOCKER_DIR=$USER_DOCKER_DIR"
# Verifica pasta do usuário usada pelo docker rootless
if [ ! -w "$USER_BASE_DIR" ]; then
echo -e "ERROR!\n USER_BASE_DIR=$USER_BASE_DIR needs to be writable!"
return 1
fi
# Cria pastas usadas pelo docker rootless
mkdir --parents $USER_DOCKER_DIR
export XDG_RUNTIME_DIR=$USER_DOCKER_DIR/.docker/run && \
export XDG_CONFIG_HOME=$USER_DOCKER_DIR/.config
mkdir --parents $XDG_RUNTIME_DIR && \
mkdir --parents $XDG_CONFIG_HOME/docker

# Cria configuração do docker rootless
echo "{\"data-root\":\"${USER_DOCKER_DIR}/docker-cache\"}" | tee $XDG_CONFIG_HOME/docker/daemon.json && \
nvidia-ctk runtime configure --runtime=docker --config=$XDG_CONFIG_HOME/docker/daemon.json

echo -e "HOME=$HOME \nXDG_CONFIG_HOME=$XDG_CONFIG_HOME \nXDG_RUNTIME_DIR=$XDG_RUNTIME_DIR \nXDG_DATA_HOME=$XDG_DATA_HOME \nDOCKER_HOST=$DOCKER_HOST" && \
echo -e "cat $XDG_CONFIG_HOME/docker/daemon.json\n" && cat $XDG_CONFIG_HOME/docker/daemon.json
echo -e "\nDocker Rootless Folders and Config Files Successfully Created!"
}

# Função para iniciar manualmente daemon do docker no modo rootless
function docker-rootless-daemon-run(){
MYUSER=$(whoami)
echo -e "Exporting Environment Variables for Docker Rootless Daemon..."
export USER_DOCKER_DIR=/draft-hdd/${MYUSER}/docker-rootless &&\
export XDG_RUNTIME_DIR=$USER_DOCKER_DIR/.docker/run && \
export XDG_CONFIG_HOME=$USER_DOCKER_DIR/.config
echo -e " USER_DOCKER_DIR=$USER_DOCKER_DIR\n XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR\n XDG_CONFIG_HOME=$XDG_CONFIG_HOME"
# Verifica pasta do usuário usada pelo docker rootless
if [ ! -w "$USER_DOCKER_DIR" ]; then
echo -e "ERROR!\n USER_DOCKER_DIR=$USER_DOCKER_DIR needs to be writable!"
return 1
fi
echo -e "HOME=$HOME \nXDG_CONFIG_HOME=$XDG_CONFIG_HOME \nXDG_RUNTIME_DIR=$XDG_RUNTIME_DIR \nXDG_DATA_HOME=$XDG_DATA_HOME \nDOCKER_HOST=$DOCKER_HOST" && \
echo -e "cat $XDG_CONFIG_HOME/docker/daemon.json\n" && cat $XDG_CONFIG_HOME/docker/daemon.json
# Start docker daemon
echo -e "Starting Docker Rootless Daemon..."
dockerd-rootless.sh
}

# Função para exportar variáveis de ambiente para executar comandos do docker rootless
function docker-rootless-export(){
MYUSER=$(whoami)
echo -e "Exporting Environment Variables for Docker Rootless Daemon..."
export USER_DOCKER_DIR=/draft-hdd/${MYUSER}/docker-rootless &&\
export DOCKER_HOST=unix://$USER_DOCKER_DIR/.docker/run/docker.sock
# Verifica pasta do usuário usada pelo docker rootless
if [ ! -w "$USER_DOCKER_DIR" ]; then
echo -e "ERROR!\n USER_DOCKER_DIR=$USER_DOCKER_DIR needs to be writable!"
return 1
fi
echo -e " USER_DOCKER_DIR=$USER_DOCKER_DIR\n DOCKER_HOST=$DOCKER_HOST"
}
</pre>
|}

=== Utilização ===
Uma vez que tiver as funções salvas em seu <code>'''~/.bashrc'''</code> elas serão usadas para:

{| class="wikitable"
|+ Como usar as funções docker-rootless-*
|-
! Função !! Descrição !! Utilização
|-
|''docker-rootless-create-dir()'' 
|Cria uma pasta para os arquivos do docker rootless daemon em <code>"/draft-hdd/<usuario>/docker-rootless"</code>
|Usada apenas a primeira vez na máquina. Se a pasta já foi criada anteriormente, não precisa mais usar essa função na mesma máquina.
|-
|''docker-rootless-daemon-run()'' 
|Executar o docker rootless daemon no terminal atual no tmux ou byobu
|Usada uma vez, para não haver outro terminal executando o docker rootless daemon na máquina.
|-
|''docker-rootless-export()'' 
|Exportar as variáveis de ambiente com o path correto do docker rootless daemon e do docker.sock (''XDG_RUNTIME_DIR'' e ''DOCKER_HOST'')
|Usada em todo novo terminal que abrir e quiser usar comando docker. Também pode ser colocada no final do ~/.bashrc para valer automaticamente.
|}

Para utilizar o docker:

# Faça ''ssh'' numa das máquinas que tem o docker rootless instalado
# Se a pasta <code>"/draft-hdd/<usuario>/docker-rootless"</code> ainda não foi criada para seu usuário na máquina, execute: <code>'''docker-rootless-create-dir'''</code>
# No terminal abra o multiplexador de terminais, por exemplo, comando: <code>'''tmux'''</code>
# Dentro da '''janela 0''' do tmux, execute o docker rootless daemon: <code>'''docker-rootless-daemon-run'''</code>
# Abra outra janela no tmux: ctrl+b c
# Na '''janela 1''' faça o export do path para executar comandos docker: <code>'''docker-rootless-export'''</code>
# Na '''janela 1''' execute os comandos docker: <code>'''docker version ; docker compose version; docker info;'''</code>
 

== Limpar dados do docker rootless: cache, images e containers ==

Para desocupar espaço em disco das máquinas, caso não esteja utilizando o docker, mas deseja manter a estrutura de pastas do docker rootless daemon, pode-se apagar todas as imagens, cache e containers com:

<code>'''docker system prune --all'''</code>

Alguns links de referencia:
* https://stackoverflow.com/questions/44785585/how-can-i-delete-all-local-docker-images
* https://contabo.com/blog/how-to-remove-docker-volumes-images-and-containers/?gad_source=1&gclid=CjwKCAjwydSzBhBOEiwAj0XN4JA5Mz8X1bAK-PaXKPz9PyQnJKdahvYG3Z6CBm5ydgRmsNymOFU9FhoC4a0QAvD_BwE
* https://earthly.dev/blog/docker-image-storage-on-host/
* https://docs.docker.com/reference/cli/docker/system/prune/#extended-description

== Docker abrindo janela no Ubuntu ==
exemplo com ROS 
<code>'''docker run --detach --privileged \ ''' 
'''--volume /tmp/.X11-unix:/tmp/.X11-unix \ ''' 
'''--volume /home:/home/host \ ''' 
'''--device=/dev/bus/usb:/dev/bus/usb \ ''' 
'''--volume /dev:/dev \ ''' 
'''--runtime=nvidia \ ''' 
'''--gpus 'all,"capabilities=utility,display,compute"' \ ''' 
'''--env DISPLAY=$DISPLAY \ ''' 
'''--network=host \ ''' 
'''--name ros_noetic_gps_testing_container \ ''' 
'''ros_noetic_gps_testing:latest \ ''' 
'''tail -f /dev/null'''</code>

== Criar regra udev para dispositivo USB ==
Para descobrir o idProduct e idVendor do dispositivo, pode-se usar:

<code> udevadm info -a -n /dev/ttyACM0 </code>

Para criar o arquivo com a regra:

<code> sudo nano /etc/udev/rules.d/99-ublox-gps.rules </code>

Adicionar essa linha no arquivo e salvar o arquivo:

<code>
SUBSYSTEM=="tty", ATTRS{idVendor}=="1546", ATTRS{idProduct}=="01a9", MODE="0666", GROUP="dialout"

</code>

Se quiser criar um novo nome (link simbolico /dev/ublox) adicionar SYMLINK:

<code>SUBSYSTEM=="tty", ATTRS{idVendor}=="1546", ATTRS{idProduct}=="01a9", SYMLINK+="ublox", MODE="0666", GROUP="dialout"
</code>

Desconectar e conectar o dispositivo da USB novamente para acionar a nova regra

Docker

2025-04-09T14:37:26Z

Isaacreyes: /* Criar regra udev para dispositivo USB */

== Docker Rootless Mode ==

O modo disponível do Docker para os usuários da rede é o '''Docker Engine no modo Rootless''', ou seja, apenas a versão em linha de comando e no modo de acesso non-root.

Em geral, funciona para todas as aplicações e pode-se ler mais informações no [https://docs.docker.com/engine/security/rootless/ link Docker Rootless]
 
'''Importante''': para estas configurações é necessário que a máquina tenha um docker instalado com versão >= 20.10 (pode ser conferido com: <code>docker version</code>)

Este processo ainda se encontra em uma fase experimental e não está disponível em todas as máquinas. As máquinas disponíveis com docker até o momento são '''PROC1, PROC2, PROC5, PROC6, PROC7, EPONA, NYMERIA, DROGON''', '''EVA, WALL-E, MAGRITTE''' e '''DALEK'''.
 

== Configuração Docker rootless com Systemd (não é possível usar simultaneamente em outras máquinas, apenas em uma máquina da rede por vez) ==

 
A opção mais intuitiva para executar o Docker Rootless é gerenciando pelo '''systemctl --user'''. Porém tem a limitação de '''funcionar em apenas uma máquina da rede por vez''', pois o arquivo que gerencia o systemctl do usuário é salvo na /home que é compartilhada em todas as máquinas, portanto '''apenas um processo docker rootless do usuário pode ser criado, mas em qualquer máquina da rede'''.

=== Pré-requisitos ===
Para utilizar docker rootless em uma máquina no laboratório é preciso que o usuário:

* solicite à equipe de rede para criar uma pasta de rascunho no disco local como /draft-xxx/nome_do_usuario e dar permissão de leitura/escrita.
* solicite à equipe de rede a instalação do docker na máquina.
 

=== Configuração ===
Feito estas etapas, para configurar o acesso na máquina é preciso seguir os seguintes passos para executar o docker rootless:

# Crie a pasta <code>~/.config/docker</code> com o comando <code>mkdir -p ~/.config/docker</code>.
# Altere a pasta de armazenamento dos arquivos de cache do Docker para a pasta de rascunho /draft-xxx com:

<code>echo '{"data-root":"/<path-em-disco-local>/<user>/docker-cache"}' | tee ~/.config/docker/daemon.json</code>
 
'''Importante:''' Lembre-se de ajustar o <code><path-em-disco-local>/<user></code> para uma armazenamento de rascunho na máquina e alguma pasta do seu usuário (por exemplo, <code>/draft-hdd/fulano</code>).
 
Esses dois primeiros passos são específicos para as máquinas do VeRLab: por padrão o Docker guarda arquivos na /home do usuário, mas essa pasta é compartilhada em rede (por NFS ou MooseFS) e o Docker não dá suporte a isso.[https://github.com/docker/for-linux/issues/1172 Aqui está um issue citando o problema]

# Execute <code>dockerd-rootless-setuptool.sh install</code>.
 
'''Importante''': Após terminar, o comando vai pedir que você altere seu .bashrc para adicionar uma linha semelhante a <code>export DOCKER_HOST=unix:///run/user/<uid>/docker.sock</code> (varia por usuário). Faça essa alteração antes de prosseguir copiando e colando o comando no terminal.
# Reinicie o Bash com <code>exec bash</code>.
# Ative a inicialização automática do Docker em seu usuário: <code>systemctl --user enable --now docker</code> ou manualmente: <code>systemctl --user start docker</code>

Com isso, a configuração está pronta!

=== Utilização ===
Comandos para confirmar se o Docker está funcionando:
* Verificar status do docker daemon: <code>systemctl --user status docker.service</code>
* Parar docker daemon: <code>systemctl --user stop docker.service</code>
* Verificar configurações do Docker Rootless: <code>docker version</code> ou <code>docker info</code>
* Baixar uma imagem teste e executá-la: <code>docker run hello-world</code>
 

== Configuração Docker Rootless "Manual" para execução simultânea em várias máquinas da rede ==

 
Essa opção pode parecer menos intuitiva, pois o usuário precisará executar manualmente o '''daemon do docker rootless''' em um terminal e mantê-lo em execução para poder utilizar os comandos docker em outros terminais.

Isso pode ser facilmente feito utilizando os [https://www.verlab.dcc.ufmg.br/mediawiki/index.php/Trabalhando_remotamente#Usando_tmux_ou_byobu:_multiplexador_de_terminais multiplexadores de terminal como tmux ou byobu].

Uma vez que parar a execução do docker daemon com ctrl+c ou fechar o terminal, isso vai "matar" a execução do docker rootless na máquina e parar todos seus containers de forma abrupta. Porém tem a flexibilidade de não precisar da pasta /home para armazenar as configurações do daemon, então com essa configuração é possível executar o docker rootless em várias máquinas simultaneamente!

=== Pré-requisitos ===
Para utilizar Docker Rootless em uma máquina no laboratório é preciso que o usuário:

* solicite à equipe de rede para criar uma pasta de rascunho no disco local como /draft-xxx/nome_do_usuario e dar permissão de leitura/escrita.
* solicite à equipe de rede a instalação do docker na máquina.

=== Configuração ===

# Abra seu arquivo <code>~/.bashrc</code> no editor de texto preferido, se for no terminal pode usar o nano: <code>'''nano ~/.bashrc'''</code>
# Cole as seguintes funções no final desse arquivo e salve o mesmo:

{| class="wikitable"
|-
! Criar arquivo de configuração do tmux para habilitar o mouse e outras coisas úteis
|-
|
<pre>
# Funções para adicionar no final do aquivo ~/.bashrc e usar docker rootless na rede VeRLab/JLab

# Função para criar pastas e configuração do docker rootless
function docker-rootless-create-dir(){
MYUSER=$(whoami)
# Cria environment variables para pastas
echo -e "Exporting Environment Variables for Docker Rootless Create Folder..."
export USER_BASE_DIR=/draft-hdd/${MYUSER} && \
export USER_DOCKER_DIR=$USER_BASE_DIR/docker-rootless &&\
echo -e " USER_BASE_DIR=$USER_BASE_DIR\n USER_DOCKER_DIR=$USER_DOCKER_DIR"
# Verifica pasta do usuário usada pelo docker rootless
if [ ! -w "$USER_BASE_DIR" ]; then
echo -e "ERROR!\n USER_BASE_DIR=$USER_BASE_DIR needs to be writable!"
return 1
fi
# Cria pastas usadas pelo docker rootless
mkdir --parents $USER_DOCKER_DIR
export XDG_RUNTIME_DIR=$USER_DOCKER_DIR/.docker/run && \
export XDG_CONFIG_HOME=$USER_DOCKER_DIR/.config
mkdir --parents $XDG_RUNTIME_DIR && \
mkdir --parents $XDG_CONFIG_HOME/docker

# Cria configuração do docker rootless
echo "{\"data-root\":\"${USER_DOCKER_DIR}/docker-cache\"}" | tee $XDG_CONFIG_HOME/docker/daemon.json && \
nvidia-ctk runtime configure --runtime=docker --config=$XDG_CONFIG_HOME/docker/daemon.json

echo -e "HOME=$HOME \nXDG_CONFIG_HOME=$XDG_CONFIG_HOME \nXDG_RUNTIME_DIR=$XDG_RUNTIME_DIR \nXDG_DATA_HOME=$XDG_DATA_HOME \nDOCKER_HOST=$DOCKER_HOST" && \
echo -e "cat $XDG_CONFIG_HOME/docker/daemon.json\n" && cat $XDG_CONFIG_HOME/docker/daemon.json
echo -e "\nDocker Rootless Folders and Config Files Successfully Created!"
}

# Função para iniciar manualmente daemon do docker no modo rootless
function docker-rootless-daemon-run(){
MYUSER=$(whoami)
echo -e "Exporting Environment Variables for Docker Rootless Daemon..."
export USER_DOCKER_DIR=/draft-hdd/${MYUSER}/docker-rootless &&\
export XDG_RUNTIME_DIR=$USER_DOCKER_DIR/.docker/run && \
export XDG_CONFIG_HOME=$USER_DOCKER_DIR/.config
echo -e " USER_DOCKER_DIR=$USER_DOCKER_DIR\n XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR\n XDG_CONFIG_HOME=$XDG_CONFIG_HOME"
# Verifica pasta do usuário usada pelo docker rootless
if [ ! -w "$USER_DOCKER_DIR" ]; then
echo -e "ERROR!\n USER_DOCKER_DIR=$USER_DOCKER_DIR needs to be writable!"
return 1
fi
echo -e "HOME=$HOME \nXDG_CONFIG_HOME=$XDG_CONFIG_HOME \nXDG_RUNTIME_DIR=$XDG_RUNTIME_DIR \nXDG_DATA_HOME=$XDG_DATA_HOME \nDOCKER_HOST=$DOCKER_HOST" && \
echo -e "cat $XDG_CONFIG_HOME/docker/daemon.json\n" && cat $XDG_CONFIG_HOME/docker/daemon.json
# Start docker daemon
echo -e "Starting Docker Rootless Daemon..."
dockerd-rootless.sh
}

# Função para exportar variáveis de ambiente para executar comandos do docker rootless
function docker-rootless-export(){
MYUSER=$(whoami)
echo -e "Exporting Environment Variables for Docker Rootless Daemon..."
export USER_DOCKER_DIR=/draft-hdd/${MYUSER}/docker-rootless &&\
export DOCKER_HOST=unix://$USER_DOCKER_DIR/.docker/run/docker.sock
# Verifica pasta do usuário usada pelo docker rootless
if [ ! -w "$USER_DOCKER_DIR" ]; then
echo -e "ERROR!\n USER_DOCKER_DIR=$USER_DOCKER_DIR needs to be writable!"
return 1
fi
echo -e " USER_DOCKER_DIR=$USER_DOCKER_DIR\n DOCKER_HOST=$DOCKER_HOST"
}
</pre>
|}

=== Utilização ===
Uma vez que tiver as funções salvas em seu <code>'''~/.bashrc'''</code> elas serão usadas para:

{| class="wikitable"
|+ Como usar as funções docker-rootless-*
|-
! Função !! Descrição !! Utilização
|-
|''docker-rootless-create-dir()'' 
|Cria uma pasta para os arquivos do docker rootless daemon em <code>"/draft-hdd/<usuario>/docker-rootless"</code>
|Usada apenas a primeira vez na máquina. Se a pasta já foi criada anteriormente, não precisa mais usar essa função na mesma máquina.
|-
|''docker-rootless-daemon-run()'' 
|Executar o docker rootless daemon no terminal atual no tmux ou byobu
|Usada uma vez, para não haver outro terminal executando o docker rootless daemon na máquina.
|-
|''docker-rootless-export()'' 
|Exportar as variáveis de ambiente com o path correto do docker rootless daemon e do docker.sock (''XDG_RUNTIME_DIR'' e ''DOCKER_HOST'')
|Usada em todo novo terminal que abrir e quiser usar comando docker. Também pode ser colocada no final do ~/.bashrc para valer automaticamente.
|}

Para utilizar o docker:

# Faça ''ssh'' numa das máquinas que tem o docker rootless instalado
# Se a pasta <code>"/draft-hdd/<usuario>/docker-rootless"</code> ainda não foi criada para seu usuário na máquina, execute: <code>'''docker-rootless-create-dir'''</code>
# No terminal abra o multiplexador de terminais, por exemplo, comando: <code>'''tmux'''</code>
# Dentro da '''janela 0''' do tmux, execute o docker rootless daemon: <code>'''docker-rootless-daemon-run'''</code>
# Abra outra janela no tmux: ctrl+b c
# Na '''janela 1''' faça o export do path para executar comandos docker: <code>'''docker-rootless-export'''</code>
# Na '''janela 1''' execute os comandos docker: <code>'''docker version ; docker compose version; docker info;'''</code>
 

== Limpar dados do docker rootless: cache, images e containers ==

Para desocupar espaço em disco das máquinas, caso não esteja utilizando o docker, mas deseja manter a estrutura de pastas do docker rootless daemon, pode-se apagar todas as imagens, cache e containers com:

<code>'''docker system prune --all'''</code>

Alguns links de referencia:
* https://stackoverflow.com/questions/44785585/how-can-i-delete-all-local-docker-images
* https://contabo.com/blog/how-to-remove-docker-volumes-images-and-containers/?gad_source=1&gclid=CjwKCAjwydSzBhBOEiwAj0XN4JA5Mz8X1bAK-PaXKPz9PyQnJKdahvYG3Z6CBm5ydgRmsNymOFU9FhoC4a0QAvD_BwE
* https://earthly.dev/blog/docker-image-storage-on-host/
* https://docs.docker.com/reference/cli/docker/system/prune/#extended-description

== Docker abrindo janela no Ubuntu ==
exemplo com ROS 
<code>'''docker run --detach --privileged \ ''' 
'''--volume /tmp/.X11-unix:/tmp/.X11-unix \ ''' 
'''--volume /home:/home/host \ ''' 
'''--device=/dev/bus/usb:/dev/bus/usb \ ''' 
'''--volume /dev:/dev \ ''' 
'''--runtime=nvidia \ ''' 
'''--gpus 'all,"capabilities=utility,display,compute"' \ ''' 
'''--env DISPLAY=$DISPLAY \ ''' 
'''--network=host \ ''' 
'''--name ros_noetic_gps_testing_container \ ''' 
'''ros_noetic_gps_testing:latest \ ''' 
'''tail -f /dev/null'''</code>

== Criar regra udev para dispositivo USB ==
Para descobrir o idProduct e idVendor do dispositivo, pode

<code> udevadm info -a -n /dev/ttyACM0 </code>

Criar o arquivo com a regra:

<code> sudo nano /etc/udev/rules.d/99-ublox-gps.rules </code>

Adicionar essa linha no arquivo :

<code>
SUBSYSTEM=="tty", ATTRS{idVendor}=="1546", ATTRS{idProduct}=="01a9", MODE="0666", GROUP="dialout"

</code>

Se quiser criar um novo nome (link simbolico /dev/ublox) adicionar SYMLINK:

<code>SUBSYSTEM=="tty", ATTRS{idVendor}=="2341", ATTRS{idProduct}=="0043", SYMLINK+="ublox", MODE="0666", GROUP="dialout"
</code>

Docker

2025-04-09T14:36:00Z

Isaacreyes: /* Docker abrindo janela no Ubuntu */

== Docker Rootless Mode ==

O modo disponível do Docker para os usuários da rede é o '''Docker Engine no modo Rootless''', ou seja, apenas a versão em linha de comando e no modo de acesso non-root.

Em geral, funciona para todas as aplicações e pode-se ler mais informações no [https://docs.docker.com/engine/security/rootless/ link Docker Rootless]
 
'''Importante''': para estas configurações é necessário que a máquina tenha um docker instalado com versão >= 20.10 (pode ser conferido com: <code>docker version</code>)

Este processo ainda se encontra em uma fase experimental e não está disponível em todas as máquinas. As máquinas disponíveis com docker até o momento são '''PROC1, PROC2, PROC5, PROC6, PROC7, EPONA, NYMERIA, DROGON''', '''EVA, WALL-E, MAGRITTE''' e '''DALEK'''.
 

== Configuração Docker rootless com Systemd (não é possível usar simultaneamente em outras máquinas, apenas em uma máquina da rede por vez) ==

 
A opção mais intuitiva para executar o Docker Rootless é gerenciando pelo '''systemctl --user'''. Porém tem a limitação de '''funcionar em apenas uma máquina da rede por vez''', pois o arquivo que gerencia o systemctl do usuário é salvo na /home que é compartilhada em todas as máquinas, portanto '''apenas um processo docker rootless do usuário pode ser criado, mas em qualquer máquina da rede'''.

=== Pré-requisitos ===
Para utilizar docker rootless em uma máquina no laboratório é preciso que o usuário:

* solicite à equipe de rede para criar uma pasta de rascunho no disco local como /draft-xxx/nome_do_usuario e dar permissão de leitura/escrita.
* solicite à equipe de rede a instalação do docker na máquina.
 

=== Configuração ===
Feito estas etapas, para configurar o acesso na máquina é preciso seguir os seguintes passos para executar o docker rootless:

# Crie a pasta <code>~/.config/docker</code> com o comando <code>mkdir -p ~/.config/docker</code>.
# Altere a pasta de armazenamento dos arquivos de cache do Docker para a pasta de rascunho /draft-xxx com:

<code>echo '{"data-root":"/<path-em-disco-local>/<user>/docker-cache"}' | tee ~/.config/docker/daemon.json</code>
 
'''Importante:''' Lembre-se de ajustar o <code><path-em-disco-local>/<user></code> para uma armazenamento de rascunho na máquina e alguma pasta do seu usuário (por exemplo, <code>/draft-hdd/fulano</code>).
 
Esses dois primeiros passos são específicos para as máquinas do VeRLab: por padrão o Docker guarda arquivos na /home do usuário, mas essa pasta é compartilhada em rede (por NFS ou MooseFS) e o Docker não dá suporte a isso.[https://github.com/docker/for-linux/issues/1172 Aqui está um issue citando o problema]

# Execute <code>dockerd-rootless-setuptool.sh install</code>.
 
'''Importante''': Após terminar, o comando vai pedir que você altere seu .bashrc para adicionar uma linha semelhante a <code>export DOCKER_HOST=unix:///run/user/<uid>/docker.sock</code> (varia por usuário). Faça essa alteração antes de prosseguir copiando e colando o comando no terminal.
# Reinicie o Bash com <code>exec bash</code>.
# Ative a inicialização automática do Docker em seu usuário: <code>systemctl --user enable --now docker</code> ou manualmente: <code>systemctl --user start docker</code>

Com isso, a configuração está pronta!

=== Utilização ===
Comandos para confirmar se o Docker está funcionando:
* Verificar status do docker daemon: <code>systemctl --user status docker.service</code>
* Parar docker daemon: <code>systemctl --user stop docker.service</code>
* Verificar configurações do Docker Rootless: <code>docker version</code> ou <code>docker info</code>
* Baixar uma imagem teste e executá-la: <code>docker run hello-world</code>
 

== Configuração Docker Rootless "Manual" para execução simultânea em várias máquinas da rede ==

 
Essa opção pode parecer menos intuitiva, pois o usuário precisará executar manualmente o '''daemon do docker rootless''' em um terminal e mantê-lo em execução para poder utilizar os comandos docker em outros terminais.

Isso pode ser facilmente feito utilizando os [https://www.verlab.dcc.ufmg.br/mediawiki/index.php/Trabalhando_remotamente#Usando_tmux_ou_byobu:_multiplexador_de_terminais multiplexadores de terminal como tmux ou byobu].

Uma vez que parar a execução do docker daemon com ctrl+c ou fechar o terminal, isso vai "matar" a execução do docker rootless na máquina e parar todos seus containers de forma abrupta. Porém tem a flexibilidade de não precisar da pasta /home para armazenar as configurações do daemon, então com essa configuração é possível executar o docker rootless em várias máquinas simultaneamente!

=== Pré-requisitos ===
Para utilizar Docker Rootless em uma máquina no laboratório é preciso que o usuário:

* solicite à equipe de rede para criar uma pasta de rascunho no disco local como /draft-xxx/nome_do_usuario e dar permissão de leitura/escrita.
* solicite à equipe de rede a instalação do docker na máquina.

=== Configuração ===

# Abra seu arquivo <code>~/.bashrc</code> no editor de texto preferido, se for no terminal pode usar o nano: <code>'''nano ~/.bashrc'''</code>
# Cole as seguintes funções no final desse arquivo e salve o mesmo:

{| class="wikitable"
|-
! Criar arquivo de configuração do tmux para habilitar o mouse e outras coisas úteis
|-
|
<pre>
# Funções para adicionar no final do aquivo ~/.bashrc e usar docker rootless na rede VeRLab/JLab

# Função para criar pastas e configuração do docker rootless
function docker-rootless-create-dir(){
MYUSER=$(whoami)
# Cria environment variables para pastas
echo -e "Exporting Environment Variables for Docker Rootless Create Folder..."
export USER_BASE_DIR=/draft-hdd/${MYUSER} && \
export USER_DOCKER_DIR=$USER_BASE_DIR/docker-rootless &&\
echo -e " USER_BASE_DIR=$USER_BASE_DIR\n USER_DOCKER_DIR=$USER_DOCKER_DIR"
# Verifica pasta do usuário usada pelo docker rootless
if [ ! -w "$USER_BASE_DIR" ]; then
echo -e "ERROR!\n USER_BASE_DIR=$USER_BASE_DIR needs to be writable!"
return 1
fi
# Cria pastas usadas pelo docker rootless
mkdir --parents $USER_DOCKER_DIR
export XDG_RUNTIME_DIR=$USER_DOCKER_DIR/.docker/run && \
export XDG_CONFIG_HOME=$USER_DOCKER_DIR/.config
mkdir --parents $XDG_RUNTIME_DIR && \
mkdir --parents $XDG_CONFIG_HOME/docker

# Cria configuração do docker rootless
echo "{\"data-root\":\"${USER_DOCKER_DIR}/docker-cache\"}" | tee $XDG_CONFIG_HOME/docker/daemon.json && \
nvidia-ctk runtime configure --runtime=docker --config=$XDG_CONFIG_HOME/docker/daemon.json

echo -e "HOME=$HOME \nXDG_CONFIG_HOME=$XDG_CONFIG_HOME \nXDG_RUNTIME_DIR=$XDG_RUNTIME_DIR \nXDG_DATA_HOME=$XDG_DATA_HOME \nDOCKER_HOST=$DOCKER_HOST" && \
echo -e "cat $XDG_CONFIG_HOME/docker/daemon.json\n" && cat $XDG_CONFIG_HOME/docker/daemon.json
echo -e "\nDocker Rootless Folders and Config Files Successfully Created!"
}

# Função para iniciar manualmente daemon do docker no modo rootless
function docker-rootless-daemon-run(){
MYUSER=$(whoami)
echo -e "Exporting Environment Variables for Docker Rootless Daemon..."
export USER_DOCKER_DIR=/draft-hdd/${MYUSER}/docker-rootless &&\
export XDG_RUNTIME_DIR=$USER_DOCKER_DIR/.docker/run && \
export XDG_CONFIG_HOME=$USER_DOCKER_DIR/.config
echo -e " USER_DOCKER_DIR=$USER_DOCKER_DIR\n XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR\n XDG_CONFIG_HOME=$XDG_CONFIG_HOME"
# Verifica pasta do usuário usada pelo docker rootless
if [ ! -w "$USER_DOCKER_DIR" ]; then
echo -e "ERROR!\n USER_DOCKER_DIR=$USER_DOCKER_DIR needs to be writable!"
return 1
fi
echo -e "HOME=$HOME \nXDG_CONFIG_HOME=$XDG_CONFIG_HOME \nXDG_RUNTIME_DIR=$XDG_RUNTIME_DIR \nXDG_DATA_HOME=$XDG_DATA_HOME \nDOCKER_HOST=$DOCKER_HOST" && \
echo -e "cat $XDG_CONFIG_HOME/docker/daemon.json\n" && cat $XDG_CONFIG_HOME/docker/daemon.json
# Start docker daemon
echo -e "Starting Docker Rootless Daemon..."
dockerd-rootless.sh
}

# Função para exportar variáveis de ambiente para executar comandos do docker rootless
function docker-rootless-export(){
MYUSER=$(whoami)
echo -e "Exporting Environment Variables for Docker Rootless Daemon..."
export USER_DOCKER_DIR=/draft-hdd/${MYUSER}/docker-rootless &&\
export DOCKER_HOST=unix://$USER_DOCKER_DIR/.docker/run/docker.sock
# Verifica pasta do usuário usada pelo docker rootless
if [ ! -w "$USER_DOCKER_DIR" ]; then
echo -e "ERROR!\n USER_DOCKER_DIR=$USER_DOCKER_DIR needs to be writable!"
return 1
fi
echo -e " USER_DOCKER_DIR=$USER_DOCKER_DIR\n DOCKER_HOST=$DOCKER_HOST"
}
</pre>
|}

=== Utilização ===
Uma vez que tiver as funções salvas em seu <code>'''~/.bashrc'''</code> elas serão usadas para:

{| class="wikitable"
|+ Como usar as funções docker-rootless-*
|-
! Função !! Descrição !! Utilização
|-
|''docker-rootless-create-dir()'' 
|Cria uma pasta para os arquivos do docker rootless daemon em <code>"/draft-hdd/<usuario>/docker-rootless"</code>
|Usada apenas a primeira vez na máquina. Se a pasta já foi criada anteriormente, não precisa mais usar essa função na mesma máquina.
|-
|''docker-rootless-daemon-run()'' 
|Executar o docker rootless daemon no terminal atual no tmux ou byobu
|Usada uma vez, para não haver outro terminal executando o docker rootless daemon na máquina.
|-
|''docker-rootless-export()'' 
|Exportar as variáveis de ambiente com o path correto do docker rootless daemon e do docker.sock (''XDG_RUNTIME_DIR'' e ''DOCKER_HOST'')
|Usada em todo novo terminal que abrir e quiser usar comando docker. Também pode ser colocada no final do ~/.bashrc para valer automaticamente.
|}

Para utilizar o docker:

# Faça ''ssh'' numa das máquinas que tem o docker rootless instalado
# Se a pasta <code>"/draft-hdd/<usuario>/docker-rootless"</code> ainda não foi criada para seu usuário na máquina, execute: <code>'''docker-rootless-create-dir'''</code>
# No terminal abra o multiplexador de terminais, por exemplo, comando: <code>'''tmux'''</code>
# Dentro da '''janela 0''' do tmux, execute o docker rootless daemon: <code>'''docker-rootless-daemon-run'''</code>
# Abra outra janela no tmux: ctrl+b c
# Na '''janela 1''' faça o export do path para executar comandos docker: <code>'''docker-rootless-export'''</code>
# Na '''janela 1''' execute os comandos docker: <code>'''docker version ; docker compose version; docker info;'''</code>
 

== Limpar dados do docker rootless: cache, images e containers ==

Para desocupar espaço em disco das máquinas, caso não esteja utilizando o docker, mas deseja manter a estrutura de pastas do docker rootless daemon, pode-se apagar todas as imagens, cache e containers com:

<code>'''docker system prune --all'''</code>

Alguns links de referencia:
* https://stackoverflow.com/questions/44785585/how-can-i-delete-all-local-docker-images
* https://contabo.com/blog/how-to-remove-docker-volumes-images-and-containers/?gad_source=1&gclid=CjwKCAjwydSzBhBOEiwAj0XN4JA5Mz8X1bAK-PaXKPz9PyQnJKdahvYG3Z6CBm5ydgRmsNymOFU9FhoC4a0QAvD_BwE
* https://earthly.dev/blog/docker-image-storage-on-host/
* https://docs.docker.com/reference/cli/docker/system/prune/#extended-description

== Docker abrindo janela no Ubuntu ==
exemplo com ROS 
<code>'''docker run --detach --privileged \ ''' 
'''--volume /tmp/.X11-unix:/tmp/.X11-unix \ ''' 
'''--volume /home:/home/host \ ''' 
'''--device=/dev/bus/usb:/dev/bus/usb \ ''' 
'''--volume /dev:/dev \ ''' 
'''--runtime=nvidia \ ''' 
'''--gpus 'all,"capabilities=utility,display,compute"' \ ''' 
'''--env DISPLAY=$DISPLAY \ ''' 
'''--network=host \ ''' 
'''--name ros_noetic_gps_testing_container \ ''' 
'''ros_noetic_gps_testing:latest \ ''' 
'''tail -f /dev/null'''</code>

== Criar regra udev para dispositivo USB ==
Para descobrir o idProduct e idVendor do dispositivo, pode

<code> udevadm info -a -n /dev/ttyACM0 <\code>

Criar o arquivo com a regra:

<code> sudo nano /etc/udev/rules.d/99-ublox-gps.rules </code>

Adicionar essa linha no arquivo :

<code>
SUBSYSTEM=="tty", ATTRS{idVendor}=="1546", ATTRS{idProduct}=="01a9", MODE="0666", GROUP="dialout"

</code>

Se quiser criar um novo nome (link simbolico /dev/ublox) adicionar SYMLINK:

<code>SUBSYSTEM=="tty", ATTRS{idVendor}=="2341", ATTRS{idProduct}=="0043", SYMLINK+="ublox", MODE="0666", GROUP="dialout"
</code>

Docker

2025-04-09T11:51:56Z

Isaacreyes: /* Limpar dados do docker rootless: cache, images e containers */