Como configurar a plataforma IDE Eclipse Theia em nuvem no CentOS 7

O autor selecionou o Free and Open Source Fund para receber uma doação como parte do programa Write for DOnations.

Introdução

Com as ferramentas de desenvolvimento na nuvem, a adoção de plataformas IDE (Ambiente de desenvolvimento integrado) em nuvem está crescendo. Os IDEs em nuvem estão acessíveis a partir de todo tipo de dispositivo moderno através de navegadores Web e oferecem várias vantagens para cenários de colaboração em tempo real. Trabalhar em um IDE em nuvem fornece um ambiente unificado de desenvolvimento e teste para você e sua equipe, ao mesmo tempo que minimiza as incompatibilidades entre plataformas. Acessível através de navegadores Web, as IDEs em nuvem estão disponíveis em todo tipo de dispositivo moderno.

A Eclipse Theia é uma função do IDE em nuvem funcionando em um servidor remoto e acessível a partir de uma navegador Web. Visualmente, ele foi criado para observar e se comportar de maneira similar ao Microsoft Visual Studio Code, o que significa que ele é compatível com várias linguagens de programação, tem um layout flexível e um terminal integrado. O que separa o Eclipse Theia de outros softwares do IDE em nuvem é a sua extensibilidade; ele pode ser modificado usando extensões personalizadas, o que permite que você crie um IDE em nuvem adequado às suas necessidades.

Neste tutorial, você irá implantar o Eclipse Theia em seu servidor CentOS 7, usando o Docker Compose, uma ferramenta de orquestração de contêineres. Você irá expô-lo em seu domínio usando o nginx-proxy, um sistema automático para o Docker que simplifica o processo de configuração do Nginx para servir como um proxy reverso para um contêiner. Você também irá proteger ele usando um certificado TLS do Let’s Encrypt gratuito, que irá fornecer usando seu add-on especializado. No final, você terá o Eclipse Theia executando em seu servidor CentOS 7, disponível através do protocolo HTTPS e que exige que o usuário faça login.

Pré-requisitos

• Um servidor CentOS 7, com privilégios raiz e uma conta secundária não raiz. Você pode configurar isto seguindo nosso Guia de configuração inicial de servidor para o CentOS 7. Para este tutorial, o usuário não raiz será o sammy.
• O Docker instalado no seu servidor. Siga o passo 1 e o passo 2 do artigo sobre Como instalar o Docker no CentOS 7. Lembre-se de fazer log-off e de fazer log-in novamente, após realizar esse pré-requisito. Para uma introdução ao Docker, consulte O ecossistema Docker: uma introdução aos componentes comuns.
• O Docker Compose instalado no seu servidor. Siga o Passo 1 do artigo sobre Como instalar o Docker Compose no CentOS 7.
• Um nome de domínio totalmente registrado. Este tutorial utilizará o theia.your-domain durante todo o processo. Você pode comprar um nome de domínio em Namecheap, obter um gratuitamente em Freenom ou usar o registrador de domínios de sua escolha.
• Um registro de DNS de tipo A com o theia.your_domain apontando para o endereço IP público do seu servidor. Você pode seguir esta introdução para DNS DigitalOcean para mais detalhes sobre como adicioná-los.

Passo 1 — Implantando o nginx-proxy com o Let’s Encrypt

Nesta seção, você implantará o nginx-proxy e seu add-on do Let’s Encrypt usando o Docker Compose. Isso habilitará o fornecimento de certificados TLS e a renovação automática, de modo que, quando implantar o Eclipse Theia, ele estará acessível em seu domínio através do HTTPS.

Para os fins deste tutorial, você armazenará todos os arquivos sob o ~/eclipse-theia. Crie o diretório executando o seguinte comando:

mkdir ~/eclipse-theia

Navegue até ele:

cd ~/eclipse-theia

Você armazenará a configuração do Docker Compose para o nginx-proxy em um arquivo chamado nginx-proxy-compose.yaml. Crie ele usando seu editor de texto:

vi nginx-proxy-compose.yaml

Adicione as linhas seguintes:

version: '2'

services:
  nginx-proxy:
    restart: always
    image: jwilder/nginx-proxy
    ports:
      - "80:80"
      - "443:443"
    volumes:
      - "/etc/nginx/htpasswd:/etc/nginx/htpasswd"
      - "/etc/nginx/vhost.d"
      - "/usr/share/nginx/html"
      - "/var/run/docker.sock:/tmp/docker.sock:ro"
      - "/etc/nginx/certs"

  letsencrypt-nginx-proxy-companion:
    restart: always
    image: jrcs/letsencrypt-nginx-proxy-companion
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock:ro"
    volumes_from:
      - "nginx-proxy"

Aqui, você está definindo dois serviços que o Docker Compose irá executar, o nginx-proxy e seu companheiro Let’s Encrypt. Para o proxy, especifique o jwilder/nginx-proxy como a imagem, mapeie as portas HTTP e HTTPS, e defina os volumes que serão acessíveis a ele durante o tempo de execução.

Os volumes são diretórios no seu servidor que o serviço definido terá acesso total a eles, que serão usados mais tarde para configurar a autenticação do usuário. Para conseguir isso, certifique-se de usar o primeiro volume da lista, que mapeia o diretório local /etc/nginx/htpasswd para o mesmo no contêiner. Naquela pasta, o nginx-proxy espera encontrar um arquivo chamado exatamente como o domínio alvo, contendo credenciais de login para a autenticação de usuário no formato htpasswd (username:hashed_password).

Para o add-on, nomeie a imagem do Docker e permita o acesso ao soquete do Docker, definindo um volume. Em seguida, especifique que o add-on deve herdar o acesso aos volumes definidos para o nginx-proxy. Ambos os serviços têm o restart definido como always, que ordena que o Docker reinicie os contêineres em caso de falha ou reinicialização do sistema.

Salve e feche o arquivo.

Implante a configuração executando:

docker-compose -f nginx-proxy-compose.yaml up -d

Aqui, você passa o nome do arquivo nginx-proxy-compose.yaml para o parâmetro -f do comando docker-compose, que especifica o arquivo a ser executado. Em seguida, você passa o verbo up que o instrui o arquivo para executar os contêineres. A flag -d habilita o modo desanexado, o que significa que o Docker Compose irá executar os contêineres em segundo plano.

A saída final ficará parecida com esta:

Output
Creating network "eclipse-theia_default" with the default driver
Pulling nginx-proxy (jwilder/nginx-proxy:)...
latest: Pulling from jwilder/nginx-proxy
8d691f585fa8: Pull complete
5b07f4e08ad0: Pull complete
...
Digest: sha256:dfc0666b9747a6fc851f5fb9b03e65e957b34c95d9635b4b5d1d6b01104bde28
Status: Downloaded newer image for jwilder/nginx-proxy:latest
Pulling letsencrypt-nginx-proxy-companion (jrcs/letsencrypt-nginx-proxy-companion:)...
latest: Pulling from jrcs/letsencrypt-nginx-proxy-companion
89d9c30c1d48: Pull complete
668840c175f8: Pull complete
...
Digest: sha256:a8d369d84079a923fdec8ce2f85827917a15022b0dae9be73e6a0db03be95b5a
Status: Downloaded newer image for jrcs/letsencrypt-nginx-proxy-companion:latest
Creating eclipse-theia_nginx-proxy_1 ... done
Creating eclipse-theia_letsencrypt-nginx-proxy-companion_1 ... done

Você implantou o nginx-proxy e seu companheiro Let’s Encrypt usando o Docker Compose. Agora, siga em frente para configurar e proteger o Eclipse Theia em seu domínio.

Passo 2 — Implantando o Eclipse Theia em Docker

Nesta seção, você criará um arquivo que contém quaisquer combinações permitidas de login que um usuário precisará de entrada. Em seguida, você implantará o Eclipse Theia em seu servidor usando o Docker Compose e irá expô-lo em seu domínio protegido usando o nginx-proxy.

Como explicado no passo anterior, o nginx-proxy espera que as combinações de login estejam em um arquivo nomeado após o domínio exposto, no formato htpasswd e armazenadas sob o diretório /etc/nginx/htpasswd no contêiner. O diretório local que mapeia para o virtual não precisa ser o mesmo que foi especificado na configuração nginx-proxy.

Para criar combinações de login, será necessário primeiro instalar o htpasswd, executando o seguinte comando:

sudo yum install httpd-tools

O pacote httpd-tools contém o utilitário htpasswd.

Crie o diretório /etc/nginx/htpasswd:

sudo mkdir -p /etc/nginx/htpasswd

Crie um arquivo que armazenará os logins para seu domínio:

sudo touch /etc/nginx/htpasswd/theia.your-domain

Lembre-se de substituir o theia.your-domain pelo seu domínio do Eclipse Theia.

Para adicionar um nome de usuário e uma combinação de senha, execute o seguinte comando:

sudo htpasswd /etc/nginx/htpasswd/theia.your-domain username

Substitua o username com o nome de usuário que quiser adicionar. Será solicitado uma senha duas vezes. Após fornecê-los, o htpasswd adicionará o nome de usuário e a senha hash ao final do arquivo. Você pode repetir este comando para a quantidade de logins que quiser adicionar.

Agora, você criará a configuração para implantar o Eclipse Theia. Você armazenará ele em um arquivo chamado eclipse-theia-compose.yaml​​​. Crie ele usando seu editor de texto:

vi eclipse-theia-compose.yaml

Adicione as linhas seguintes:

version: '2.2'

services:
  eclipse-theia:
    restart: always
    image: theiaide/theia:next
    init: true
    environment:
      - VIRTUAL_HOST=theia.your-domain
      - LETSENCRYPT_HOST=theia.your-domain

Nesta configuração, defina um serviço único chamado de eclipse-theia com o restart ajustado para always e a theiaide/theia:next como a imagem do contêiner. Defina também o init para true para assim instruir o Docker para usar o init como o gerenciador de processos principal ao executar o Eclipse Theia dentro do contêiner.

Em seguida, especifique duas variáveis de ambiente na seção de environment: VIRTUAL_HOST e LETSENCRYPT_HOST. A primeira é passada para o nginx-proxy e diz a ele em qual domínio o contêiner deve ser exposto, enquanto a última é usada pelo add-on do Let’s Encrypt e especifica para qual domínio se deve solicitar certificados TLS. A menos que especifique um curinga como o valor para o VIRTUAL_HOST, eles devem ser iguais.

Lembre-se de substituir o theia.your-domain​​​ pelo seu domínio desejado; em seguida, salve e feche o arquivo.

Agora implante o Eclipse Theia executando:

docker-compose -f eclipse-theia-compose.yaml up -d

A saída final se parecerá com a seguinte:

Output
...
Pulling eclipse-theia (theiaide/theia:next)...
next: Pulling from theiaide/theia
63bc94deeb28: Pull complete
100db3e2539d: Pull complete
...
Digest: sha256:c36dff04e250f1ac52d13f6d6e15ab3e9b8cad9ad68aba0208312e0788ecb109
Status: Downloaded newer image for theiaide/theia:next
Creating eclipse-theia_eclipse-theia_1 ... done

Em seguida, no seu navegador, navegue até o domínio que está usando para o Eclipse Theia. Seu navegador mostrará um prompt pedindo que faça login. Após fornecer as credenciais corretas, você acessará o Eclipse Theia e verá imediatamente seu editor GUI. Na sua barra de endereço, você verá um cadeado que indica que a conexão está segura. Se não o ver imediatamente, espere alguns minutos para que os certificados TLS sejam provisionados, então recarregue a página.

Agora que tem acesso ao seu IDE em nuvem com segurança, você começará a usar o editor no próximo passo.

Passo 3 — Usando a interface Eclipse Theia

Nesta seção, você irá explorar alguns dos recursos da interface Eclipse Theia.

No lado esquerdo do IDE, há uma linha vertical de quatro botões que abrem os recursos mais usados em um painel lateral.

Essa barra pode ser personalizada para que você possa mover essas visualizações em uma ordem diferente ou removê-las da barra. Por padrão, a primeira visualização abre o painel do Explorer que fornece navegação em formato de árvore da estrutura do projeto. Você pode gerenciar suas pastas e arquivos aqui —criando, excluindo, movendo e renomeando-as conforme necessário.

Após criar um novo arquivo através do menu File, verá um arquivo vazio aberto em uma nova aba. Assim que for salvo, veja o nome do arquivo no painel lateral do Explorer. Para criar pastas, clique com o botão direito na barra lateral do Explorer e clique em New Folder. Você pode expandir uma pasta clicando em seu nome e da mesma forma pode arrastar e derrubar arquivos e pastas nas partes superiores da hierarquia para movê-los para uma nova localização.

As duas opções seguintes fornecem acesso às funções buscar e substituir. Em seguida, o próximo fornece uma visualização dos sistemas de controle da fonte que você possa estar usando, como o Git.

A visualização final é a opção depurador, que fornece todas as ações comuns para a depuração no painel. Você pode salvar as configurações de depuração no arquivo launch.json.

A parte central da GUI é o seu editor, que pode ser separado por guias para a edição de códigos. Você pode alterar sua visualização de edição para um sistema em grade ou para arquivos lado a lado. Como todos os IDEs modernos, o Eclipse Theia é compatível com o realce de sintaxe para seu código.

Você pode ter acesso a um terminal digitando CTRL+SHIFT+` , ou clicando no Terminal no menu superior, e selecionando New Terminal. O terminal abrirá em um painel inferior e seu diretório de trabalho será definido como o espaço de trabalho do projeto, que contém os arquivos e pastas mostrados no painel lateral do Explorer.

Você explorou uma visão geral de alto nível da interface do Eclipse Theia e revisou algumas das funcionalidades mais utilizadas.

Conclusão

Agora, você tem o Eclipse Theia, um IDE em nuvem versátil, instalado no seu servidor CentOS 7, usando o Docker Compose e o nginx-proxy. Você o protegeu com um certificado TLS do Let’s Encrypt gratuito e configurou a instância para exigir as credenciais de login do usuário. Você pode trabalhar no seu código e nos documentos de origem com ele sozinho ou colaborar com sua equipe. Também é possível tentar compilar sua própria versão do Eclipse Theia se precisar de recursos adicionais. Para obter mais informações sobre como fazer isso, visite os documentos do Theia.