Singularity

From VeRLab Wiki
Revision as of 16:29, 23 August 2019 by Mauferrari (talk | contribs) (→‎Links para aprender Singularity e Criar sua Máquina Container)
Jump to: navigation, search

Singularity

O Singularity é uma ferramenta para a criação de "máquina container" (uma espécie de "máquina virtual") que trás algumas vantagens, quando for rodar experimentos nas máquinas de processamento do Verlab/J:

  • Não precisa ser usuário com privilégios root para executar sua máquina container (apenas para criar) e pode instalar suas dependências de experimento no container sem alterar a máquina host. Isso evita mudanças e instalação de pacotes nas máquinas de processamento e que podem atrapalham experimentos de outros usuários.
  • Depois de criar sua máquina container com todas suas dependências, pode-se usá-la para rodar experimento em diferentes máquinas host que tenham GPU. Isso trás flexibilidade para rodar experimento em máquinas simultaneamente, sem precisar instalar todas dependências novamente em outra máquina host.
  • A massa de arquivos de dataset (que geralmente ocupam espaço >=500GB) ficam localmente armazenados na máquina host, assim evita tráfego desnecessário na rede. Geralmente na pasta /homeLocal/nome_do_usuario.
  • O usuário deixa na sua pasta home da rede apenas sua máquina container em formato de imagem (que em geral ocupa ~4GB) assim basta logar em uma máquina de processamento para rodar seu experimento.

Instalação

Toda máquina de processamento do Verlab/J (máquinas com GPU) deve ter o Singularity instalado e não precisam ter pacotes específicos de software como ROS, cuda, tensorflow.

A equipe de rede é responsável por:

  • Instalar o Singularity em toda máquina host com GPU (máquina de processamento)
  • Criar a pasta /homeLocal em toda máquina host para os usuários criarem e modificarem suas máquinas container.
  • Configurar o comando $sudo singularity ... de modo que todo usuário possa rodá-lo dentro da pasta /homeLocal, sem necessitar de senha root

IMPORTANTE: Diferença entre os 3 formatos criados pelo build:

  • Arquivo único, extensão .simg: destinado para fase de experimentos em massa (produção)
    • Vantagem: Em geral, ocupa menos espaço e executa mais rápido que um container equivalente no formato .img. Indicado para produção, versão final de experimentos.
    • Desvantagem: Não pode-se fazer modificação no container. Para Instalar algo, tem que transformar em .img ou "pasta sandbox".
    • (single file) compressed read-only squashfs file system suitable for production (default)


  • Arquivo único, extensão .img: fase de desenvolvimento, mas com container sofrendo poucas alterações.
    • Vantagem: Em geral, ocupa menos espaço e executa mais rápido que um container equivalente no formato "pasta sandbox". E ainda pode-se instalar pacotes (opção --writable), porém tem limitação de espaço em disco.
    • Desvantagem: O disco tem tamanho fixo, então é possível fazer modificações e instalações com opção --writable, mas se não couber no disco, o mesmo tem que ser expandido manualmente com image.expand --size
    • (single file): writable ext3 file system suitable for interactive development ( --writable option )


  • Pasta Sandbox sandbox directory : destinado para desenvolvimento inicial do container, quando ainda não se sabe exatamente as configurações e ferramentas a serem usadas, logo o container ainda sofre muitas alterações.
    • Vantagem: vários arquivos e sub-pastas que são expansíveis automaticamente conforme vai-se instalando pacotes (opção --writable). O tamanho do disco é expansível conforme disponibilidade da máquina host.
    • Desvantagem: Mais lento dos formatos para execução!
    • (many files and sub-folders): writable (ch)root directory called a sandbox for interactive development ( --sandbox option)

Regras de bom uso dos recursos

  • A máquina container para rodar os experimentos deve estar em formato de imagem para rodar mais rápido (.img ou .simg). Porém, enquanto estiver em teste e instalando pacotes, ela deve ser uma "pasta sandbox".
  • Usuários não devem deixar o dataset (massa de arquivos grande, em geral >=500GB, que vão ser acessados durante o experimento) dentro da sua pasta home na rede (por exemplo, para o login "fulano" /home/fulano/dataset na rede, pois isso aumenta o tráfego na rede desnecessáriamente. Os datasets devem ser armazenados numa pasta local do computador com o nome do usuário ou no servidor de storage. Por exemplo /homeLocal/fulano/dataset /storage/dataset/fulano/dataset
  • Cada usuário deve criar/preparar sua máquina container em uma pasta local e executá-la em "modo edição" e como "pasta sandbox" (--writable) para instalar os pacotes e dependências para seus experimentos. Por exemplo, usar a pasta local /homeLocal/fulano/my_container . Depois de pronta, a máquina container, pode ser convertida para o formato de imagem (.img ou .simg) e ser ser armazenado na pasta home da rede, assim pode ser executada como leitura de qualquer máquina de processamento que o usuário logar.
  • Use sudo somente quando necessário (e.g., instalação de pacotes e configuração). Quando for rodar o container para experimentos, não será necessário invocar o singularity com permissão sudo.

singularity image.expand my_test.simg

Links para aprender Singularity e Criar sua Máquina Container

  • Documentação oficial:

https://www.sylabs.io/docs/ (desde julho/2018)

https://singularity.lbl.gov/docs-docker


  • More details about the different build options and best practices, read singularity flow:

https://www.sylabs.io/guides/2.5.1/user-guide/singularity_flow.html#singularity-flow


  • Docker Hub: várias imagens prontas com ferramentas instaladas

https://hub.docker.com/

Para usar um endereço de imagem docker hub, usa-se o formato docker://REPOSITORIO:TAGS Por exemplo, um repósitório com imagens que contem ubuntu+python3+opencv: https://hub.docker.com/r/jjanzic/docker-python3-opencv Ao seguir o link, vai encontrar diversas TAGS listadas na pagina: List of available docker tags: 

   opencv-4.1.0 (latest branch)
   contrib-opencv-4.1.0 (opencv_contrib branch)
   opencv-4.0.1
   contrib-opencv-4.0.1
   opencv-4.0.0
   contrib-opencv-4.0.0
   opencv-3.4.2
   contrib-opencv-3.4.2

Assim um exemplo do endereço usado para criar o container será: sudo singularity build --sandbox opencv-base docker://jjanzic/docker-python3-opencv:opencv-4.0.1

Alguns Comandos Básicos

https://www.sylabs.io/guides/2.5.1/user-guide/quick_start.html#interact-with-images

  • build: Cria uma imagem para a máquina container old link
  • shell: Executa a máquina container no prompt do shell old link
  • exec: Executa um comando dentro do shell da máquina container, em segundo plano, e apresenta o resultado no shell da máquina host old link
  • run: Executa ações e scripts configurados no container, como se fosse um executável. old link
  • pull: ??? Copia um container de um repositório, pasta sandbox ou imagem pronta ???

Criar uma máquina container

  • Criar uma máquina container em formato .simg (read-only) a partir de um repositório Docker Hub:

singularity build lolcow.simg docker://godlovedc/lolcow


  • Criar uma máquina container em formato .img (read-only) a partir de um repositório Docker Hub:

sudo singularity build my_ubuntu.img docker://index.docker.io/library/ubuntu:latest


  • Criar uma máquina container em formato .img (writable) a partir de um repositório Docker Hub:

sudo singularity build --writable my_ubuntu.img docker://index.docker.io/library/ubuntu:latest


  • Criar uma máquina container container formato de estrutura de diretórios (formato sandbox) a partir do repositório Ubuntu 16.04 do Docker Hub: (Dicas sobre a opção --sandbox)

sudo singularity build --sandbox my_container/ docker://index.docker.io/library/ubuntu:latest

sudo singularity build --sandbox my_container/ docker://index.docker.io/library/ubuntu:16.04

  • Criar um sandbox usando um repositório qualquer do dockerhub

sudo singularity build --sandbox my_container/ docker://repository_name:tag


sudo singularity build my_ubuntu.simg my_container/

Executar a máquina container no shell:

You can make changes to the container (assuming you have the proper permissions to do so) but those changes will disappear as soon as you exit. To make your changes persistent across sessions, use the --writable option. It’s also a good practice to shell into your container as root to ensure you have permissions to write where you like.

  • Executar a máquina container no shell, sem salvar modificações feitas na sessão:

singularity shell my_container/

singularity shell my_ubuntu.img/

sudo singularity shell my_ubuntu.img/ - para algum teste de configuração ou instalação de pacote temporário

sudo singularity shell --writable my_container/ - para instalação de pacotes / configuração

singularity shell --writable my_container/ - para a execução de experimentos

Exemplos com exec

Retrieved from "http://www.verlab.dcc.ufmg.br/mediawiki/index.php?title=Singularity&oldid=623"