One place for hosting & domains

      Como configurar a plataforma IDE em nuvem code-server no Ubuntu 20.04


      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 criação e adoção de plataformas IDE (Ambiente de desenvolvimento integrado) em nuvem está crescendo. Os IDEs em nuvem permitem que a colaboração em tempo real entre as equipes de desenvolvedores funcione em um ambiente unificado de desenvolvimento que minimiza as incompatibilidades e aumenta a produtividade. Acessível através de navegadores Web, os IDEs [ambientes de desenvolvimento integrado] baseados em nuvem estão disponíveis em todo tipo de dispositivo moderno.

      O code-server é o Visual Studio Code da Microsoft em execução em um servidor remoto e acessível diretamente do seu navegador. O Visual Studio Code é um editor de códigos moderno com suporte Git integrado, um depurador de códigos, um sistema de preenchimento automático inteligente e recursos personalizáveis e extensíveis. Isso significa que você pode usar vários dispositivos que executem sistemas operacionais diferentes, tendo sempre um ambiente de desenvolvimento consistente à mão.

      Neste tutorial, você irá configurar a plataforma IDE em nuvem code-server na sua máquina com Ubuntu 20.04 e irá expô-la no seu domínio, protegida por certificados TLS gratuitos do Let’s Encrypt. Ao final, terá o Microsoft Visual Studio Code em execução no seu servidor Ubuntu 20.04, disponível no seu domínio e protegido com uma senha.

      Pré-requisitos

      • Um servidor executando o Ubuntu 20.04, com pelo menos 2 GB de memória RAM e uma conta não root com privilégios sudo. Você pode configurar isso seguindo este guia de configuração inicial de servidor.

      • O Nginx instalado no seu servidor. Para obter um guia sobre como instalar o Nginx, complete os Passos 1 a 4 de Como instalar o Nginx no Ubuntu 20.04.

      • Um nome de domínio totalmente registrado para hospedar o code-server, apontado para o seu servidor. Este tutorial usará o code-server.your-domain durante todo o processo. Você pode comprar um nome de domínio em Namecheap, obter um gratuitamente em Freenom ou usar o registrado de domínios de sua escolha. Para a DigitalOcean, siga esta introdução ao DNS da DigitalOcean para obter mais detalhes sobre como adicioná-los.

      Passo 1 — Instalando o code-server

      Nesta seção, você irá configurar o code-server no seu servidor. Isso implica em baixar a versão mais recente e criar um serviço systemd que irá manter o code-server executando sempre em segundo plano. Você também especificará uma política de reinicialização para o serviço, de modo que o code-server permaneça disponível após possíveis falhas ou reinicializações.

      Todos os dados relacionados com o code-server serão armazenados em uma pasta chamada ~/code-server. Crie-a executando o seguinte comando:

      Navegue até ela:

      Você precisará acessar a página de lançamentos do Github do code-server e escolher a compilação mais recente do Linux (o arquivo terá ‘linux’ em seu nome). No momento em que este artigo foi escrito, a versão mais recente era a 3.3.1. Baixe-a usando o wget, executando o seguinte comando:

      • wget https://github.com/cdr/code-server/releases/download/v3.3.1/code-server-3.3.1-linux-amd64.tar.gz

      Então, descompacte o arquivo executando:

      • tar -xzvf code-server-3.3.1-linux-amd64.tar.gz

      Você receberá uma pasta com o mesmo nome do arquivo original que baixou, que contém o código fonte do code-server. Copie-o para a pasta /usr/lib/code-server, para que você possa acessá-lo em todo o sistema ao executar o seguinte comando:

      • sudo cp -r code-server-3.3.1-linux-amd64 /usr/lib/code-server

      Em seguida, crie um link simbólico em /usr/bin/code-server, apontando para o executável do code-server:

      • sudo ln -s /usr/lib/code-server/bin/code-server /usr/bin/code-server

      Em seguida, crie uma pasta para o code-server, onde serão armazenados os dados de usuário:

      • sudo mkdir /var/lib/code-server

      Agora que baixou o code-server e o tornou disponível em todo o sistema, você criará um serviço systemd para manter o code-server executando sempre em segundo plano.

      Você armazenará a configuração de serviço em um arquivo chamado code-server.service, no diretório /lib/systemd/system, onde o systemd armazena seus serviços. Crie-o usando seu editor de texto:

      • sudo nano /lib/systemd/system/code-server.service

      Adicione as linhas a seguir:

      /lib/systemd/system/code-server.service

      [Unit]
      Description=code-server
      After=nginx.service
      
      [Service]
      Type=simple
      Environment=PASSWORD=your_password
      ExecStart=/usr/bin/code-server --bind-addr 127.0.0.1:8080 --user-data-dir /var/lib/code-server --auth password
      Restart=always
      
      [Install]
      WantedBy=multi-user.target
      

      Aqui, especifique primeiro a descrição do serviço. Depois, você vai declarar que o serviço nginx deve ser iniciado antes deste aqui. Após a seção [Unit], você deve definir o tipo de serviço (simple, que significa que o processo deve ser simplesmente executado) e fornecer o comando que será executado.

      Você também especificará que o executável global do code-server deve ser iniciado com alguns argumentos específicos do code-server. --bind-addr 127.0.0.1:8080 vincula-o ao localhost na porta 8080, de modo que ele somente fica acessível diretamente de dentro do seu servidor. --user-data-dir /var/lib/code-server define seu diretório de dados de usuário e – auth password especifica que ele deve autenticar visitantes com uma senha, especificada na variável de ambiente PASSWORD, declarada na linha acima dele.

      Lembre-se de substituir o your_password pela senha desejada e, em seguida, salve e feche o arquivo.

      A próxima linha diz ao systemd para reiniciar o code-server em todos os eventos de mal funcionamento (por exemplo, quando ele falha ou o processo é terminado). A seção [Install] ordena que o systemd inicie esse serviço quando for possível fazer login no seu servidor.

      Inicie o serviço code-server executando o seguinte comando:

      • sudo systemctl start code-server

      Verifique se ele foi iniciado corretamente, observando seu status:

      • sudo systemctl status code-server

      Você verá um resultado parecido com este:

      Output

      ● code-server.service - code-server Loaded: loaded (/lib/systemd/system/code-server.service; disabled; vendor preset: enabled) Active: active (running) since Wed 2020-05-20 13:03:40 UTC; 12s ago Main PID: 14985 (node) Tasks: 18 (limit: 2345) Memory: 26.1M CGroup: /system.slice/code-server.service ├─14985 /usr/lib/code-server/bin/../lib/node /usr/lib/code-server/bin/.. --bind-addr 127.0.0.1:8080 --user-data-dir /var/lib/code-server --auth> └─15010 /usr/lib/code-server/lib/node /usr/lib/code-server --bind-addr 127.0.0.1:8080 --user-data-dir /var/lib/code-server --auth password May 20 13:03:40 code-server-update-2004 systemd[1]: Started code-server. May 20 13:03:40 code-server-update-2004 code-server[15010]: info Wrote default config file to ~/.config/code-server/config.yaml May 20 13:03:40 code-server-update-2004 code-server[15010]: info Using config file ~/.config/code-server/config.yaml May 20 13:03:40 code-server-update-2004 code-server[15010]: info Using user-data-dir /var/lib/code-server May 20 13:03:40 code-server-update-2004 code-server[15010]: info code-server 3.3.1 6f1309795e1cb930edba68cdc7c3dcaa01da0ab3 May 20 13:03:40 code-server-update-2004 code-server[15010]: info HTTP server listening on http://127.0.0.1:8080 May 20 13:03:40 code-server-update-2004 code-server[15010]: info - Using password from $PASSWORD May 20 13:03:40 code-server-update-2004 code-server[15010]: info - To disable use `--auth none` May 20 13:03:40 code-server-update-2004 code-server[15010]: info - Not serving HTTPS

      Para fazer o code-server iniciar automaticamente após a reinicialização de um servidor, habilite seu serviço executando o seguinte comando:

      • sudo systemctl enable code-server

      Neste passo, você baixou o code-server e o disponibilizou globalmente. Depois, você criou um serviço systemd para ele e o habilitou, de modo que o code-server será iniciado a cada inicialização do servidor. Em seguida, você irá expô-lo no seu domínio, configurando o Nginx para servir como um proxy reverso entre o visitante e o code-server.

      Passo 2 — Expondo o code-server em seu domínio

      Nesta seção, você irá configurar o Nginx como um proxy reverso para o code-server.

      Como aprendeu no passo com os pré-requisitos para usar o Nginx, os arquivos de configuração do servidor Nginx ficam armazenados em /etc/nginx/sites-available e posteriormente deverão ser simbolicamente associados ao /etc/nginx/sites-enabled para se tornarem ativos.

      Você armazenará a configuração para expor o code-server em seu domínio, em um arquivo chamado code-server.conf, sob /etc/nginx/sites-available. Inicie criando o arquivo, usando o seu editor:

      • sudo nano /etc/nginx/sites-available/code-server.conf

      Adicione as linhas a seguir:

      /etc/nginx/sites-available/code-server.conf

      server {
          listen 80;
          listen [::]:80;
      
          server_name code-server.your-domain;
      
          location / {
            proxy_pass http://localhost:8080/;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection upgrade;
            proxy_set_header Accept-Encoding gzip;
          }
      }
      

      Substitua code-server.your-domain pelo domínio desejado e, em seguida, salve e feche o arquivo.

      Nesse arquivo, você vai definir que o servidor Nginx deverá escutar a porta HTTP 80. Então, especificará um server_name que dirá ao Nginx para qual domínio ele deve aceitar pedidos, aplicando essa configuração específica. No próximo bloco, para o local raiz (/), você especificará que os pedidos devem ser intercambiados com o code-server que está executando no localhost:8080. As três linhas seguintes (começando por proxy_set_header) ordenam que o Nginx transporte alguns cabeçalhos de pedidos HTTP – que são necessários para o funcionamento correto do WebSockets e que o code-server utiliza amplamente.

      Para ativar a configuração desse site, você precisará criar uma ligação simbólica dele na pasta /etc/nginx/sites-enabled, executando:

      • sudo ln -s /etc/nginx/sites-available/code-server.conf /etc/nginx/sites-enabled/code-server.conf

      Para testar a validade da configuração, execute o seguinte comando:

      Você verá o seguinte resultado:

      Output

      nginx: the configuration file /etc/nginx/nginx.conf syntax is ok nginx: configuration file /etc/nginx/nginx.conf test is successful

      Para que a configuração entre em vigor, você precisará reiniciar o Nginx:

      • sudo systemctl restart nginx

      Agora, você tem sua instalação do code-server acessível no seu domínio. No próximo passo, irá protegê-lo, aplicando um certificado TLS gratuito do Let’s Encrypt.

      Passo 3 — Protegendo seu domínio

      Nesta seção, você irá proteger seu domínio usando um certificado TLS do Let’s Encrypt, que será fornecido usando o Certbot.

      Para instalar a versão mais recente do Certbot e do seu plug-in do Nginx, execute o seguinte comando:

      • sudo apt install certbot python3-certbot-nginx

      Como parte dos pré-requisitos, você habilitou o ufw (Uncomplicated Firewall) [Firewall descomplicado] e o configurou de modo a permitir tráfego de HTTP não criptografado. Para conseguir acessar o site protegido, você precisará configurá-lo para aceitar o tráfego criptografado, executando o seguinte comando:

      O resultado será:

      Output

      Rule added Rule added (v6)

      Assim como acontece com o Nginx, você terá que recarregá-lo para que a configuração entre em vigor:

      O resultado será:

      Output

      Firewall reloaded

      Depois, no seu navegador, navegue até o domínio que usou para o code-server. Você verá o prompt de login do code-server.

      prompt de login do code-server

      O code-server está pedindo sua senha. Digite a senha que você definiu no passo anterior e pressione** Enter IDE**. Agora, você entrará no code-server e logo verá a interface gráfica do usuário (GUI) do seu editor.

      GUI do code-server

      Agora que verificou se o code-server está corretamente exposto no seu domínio, você instalará certificados TLS do Let’s Encrypt para protegê-lo, usando o Certbot.

      Para solicitar certificados para seu domínio, execute o seguinte comando:

      • sudo certbot --nginx -d code-server.your-domain

      Nesse comando, você executa o certbot para solicitar certificados para o seu domínio — e envia o nome de domínio com o parâmetro -d. O sinalizador --nginx diz a ele para alterar automaticamente a configuração do site do Nginx para oferecer suporte ao HTTPS. Lembre-se de substituir o code-server.your-domain pelo seu próprio nome de domínio.

      Se for a primeira vez que você executa o Certbot, será solicitado que você forneça um endereço de e-mail para avisos urgentes e aceite os Termos de serviço do EFF. Então, o Certbot irá solicitar certificados do Let’s Encrypt para o seu domínio. Em seguida, ele irá perguntar se você deseja redirecionar todo o tráfego HTTP para o HTTPS:

      Output

      Please choose whether or not to redirect HTTP traffic to HTTPS, removing HTTP access. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1: No redirect - Make no further changes to the webserver configuration. 2: Redirect - Make all requests redirect to secure HTTPS access. Choose this for new sites, or if you're confident your site works on HTTPS. You can undo this change by editing your web server's configuration. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Select the appropriate number [1-2] then [enter] (press 'c' to cancel):

      É recomendável selecionar a segunda opção para maximizar a segurança. Após digitar sua seleção, pressione ENTER.

      O resultado será semelhante a este:

      Output

      IMPORTANT NOTES: - Congratulations! Your certificate and chain have been saved at: /etc/letsencrypt/live/code-server.your-domain/fullchain.pem Your key file has been saved at: /etc/letsencrypt/live/code-server.your-domain/privkey.pem Your cert will expire on ... To obtain a new or tweaked version of this certificate in the future, simply run certbot again with the "certonly" option. To non-interactively renew *all* of your certificates, run "certbot renew" - Your account credentials have been saved in your Certbot configuration directory at /etc/letsencrypt. You should make a secure backup of this folder now. This configuration directory will also contain certificates and private keys obtained by Certbot so making regular backups of this folder is ideal. - If you like Certbot, please consider supporting our work by: Donating to ISRG / Let's Encrypt: https://letsencrypt.org/donate Donating to EFF: https://eff.org/donate-le

      Isso significa que o Certbot gerou com sucesso os certificados TLS e que os aplicou à configuração do Nginx para seu domínio. Neste ponto, você já pode recarregar o domínio do seu code-server no seu browser. Poderá, ainda, observar um cadeado à esquerda do endereço do site, o que significa que sua conexão está devidamente protegida.

      Agora que o code-server se encontra acessível em seu domínio, através de um proxy reverso protegido do Nginx, você está pronto para revisar a interface de usuário do code-server.

      Passo 4 — Usando a interface do code-server

      Nesta seção, você irá usar alguns dos recursos da interface do code-server. Como o code-server é o Visual Studio Code executado em nuvem, ele tem a mesma interface que a edição da área de trabalho independente.

      À esquerda do IDE, há uma linha vertical de seis botões que abrem os recursos usados com mais frequência, em um painel lateral conhecido como Barra de Atividades.

      GUI do code-server - 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, o primeiro botão abre o menu geral em uma lista suspensa, enquanto a segunda visualização abre o painel do Explorer que fornece navegação do tipo árvore da estrutura do projeto. Você pode gerenciar suas pastas e arquivos aqui —criando, excluindo, movendo e renomeando-as conforme necessário. A próxima visualização fornece acesso a uma funcionalidade de busca e substituição.

      Depois disso, na ordem padrão, vem sua visualização dos sistemas de controle de origem, como o Git. O Visual Studio Code também oferece suporte a outros fornecedores de controle de origem; você pode encontrar mais instruções para fluxos de trabalho de controle de origem nesta documentação.

      Painel do Git com o menu de contexto aberto

      A opção de depurador na Barra de Atividades fornece todas as ações comuns para depuração no painel. O Visual Studio Code vem com suporte integrado para o depurador de tempo de execução do Node.js e qualquer linguagem que transcompila para o Javascript. Para outras linguagens, você pode instalar as extensions para o depurador necessário. Você pode salvar as configurações de depuração no arquivo launch.json.

      Visualização do Depurador com o launch.json aberto

      A visualização final na Barra de Atividades fornece um menu para acessar as extensões disponíveis no Marketplace.

      Guias da GUI do code-server

      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.

      Exibição em Grade do Editor

      Após criar um novo arquivo através do menu File, um arquivo vazio irá abrir em uma nova guia e, uma vez salvo, o nome do arquivo poderá ser visualizado no painel lateral do Explorer. Para criar pastas, clique com o botão direito do mouse na barra lateral do Explorer e clique na opção New Folder. Você pode expandir uma pasta clicando em seu nome, bem como arrastar e soltar arquivos e pastas nas partes superiores da hierarquia – para movê-los para uma nova localização.

      GUI do code-server - Nova pasta

      Você pode obter acesso a um terminal, digitando CTRL+SHIFT+`, ou clicando em Terminal, no menu suspenso 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 code-server e revisou algumas das funcionalidades mais utilizadas.

      Conclusão

      Agora, você tem o code-server, um IDE em nuvem versátil, instalado no seu servidor Ubuntu 20.04, exposto no seu domínio e protegido com os certificados do Let’s Encrypt. Desta forma, você pode trabalhar em projetos individualmente, bem como em uma configuração de trabalho colaborativo em equipe. Executar um IDE em nuvem libera recursos em sua máquina local e permite a você dimensionar os recursos quando necessário. Para mais informações, consulte a documentação do Visual Studio Code para obter recursos adicionais e instruções detalhadas em outros componentes do code-server.

      Caso queira executar o code-server no cluster do seu Kubernetes da DigitalOcean, verifique nosso tutorial sobre Como configurar a plataforma IDE em nuvem do code-server no Kubernetes da DigitalOcean.



      Source link

      Como configurar a plataforma IDE na nuvem do Eclipse Theia no Ubuntu 18.04 [Início rápido]


      Introdução

      O Eclipse Theia é um IDE em nuvem extensível que executa em um servidor remoto, podendo ser acessado a partir de um navegador Web. Visualmente, ele foi projetado para parecer e se comportar de maneira similar ao Microsoft Visual Studio Code. O que separa o Eclipse Theia de outros softwares de IDE em nuvem é a sua extensibilidade; ele pode ser modificado com extensões personalizadas, o que permite que você crie um IDE em nuvem adequado às suas necessidades.

      Neste tutorial, você implantará o Eclipse Theia para seu servidor Ubuntu 18.04, usando o Docker Compose. Você irá expô-lo em seu domínio usando o nginx-proxy e o protegerá com um certificado TLS do Let’s Encrypt, o qual você irá provisionar com um add-on. Para obter uma versão mais detalhada deste tutorial, consulte o artigo sobre Como configurar a plataforma de IDE em nuvem Eclipse Theia no Ubuntu 18.04.

      Pré-requisitos

      Crie o diretório para armazenar todos os dados do Eclipse Theia:

      Navegue até ele:

      Crie o nginx-proxy-compose.yaml para armazenar a configuração do Docker Compose para o nginx-proxy:

      • nano nginx-proxy-compose.yaml

      Adicione as linhas a seguir:

      ~/eclipse-theia/nginx-proxy-compose.yaml

      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ê definirá dois serviços que o Docker Compose irá executar, o nginx-proxy e seu companheiro Let’s Encrypt. Para o proxy, você especificará o jwilder/nginx-proxy como a imagem, mapeando as portas HTTP e HTTPS e definindo os volumes que ficarão acessíveis para o proxy durante o tempo de execução.

      Salve e feche o arquivo.

      Implante a configuração:

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

      O resultado final ficará parecido com este:

      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

      Passo 2 — Implantando o Eclipse Theia em Docker

      O nginx-proxy espera que as combinações de login estejam em um arquivo que tem o mesmo nome do domínio exposto, no formato htpasswd e armazenadas sob o diretório /etc/nginx/htpasswd, no contêiner.

      Instale o htpasswd:

      • sudo apt install apache2-utils

      O pacote apache2-utils contém o utilitário htpasswd.

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

      • sudo mkdir -p /etc/nginx/htpasswd

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

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

      Execute o comando a seguir com um nome de usuário e uma combinação de senha:

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

      O htpasswd adicionará o nome de usuário e a senha hash ao final do arquivo.

      Crie a configuração para a implantação do Eclipse Theia:

      • nano eclipse-theia-compose.yaml

      Adicione as linhas a seguir:

      ~/eclipse-theia/eclipse-theia-compose.yaml

      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
      

      Você define um serviço único chamado eclipse-theia com o restart configurado para always e o theiaide/theia:next como a imagem do contêiner. Defina também o init para true. Em seguida, especifique duas variáveis de ambiente na seção de environment: VIRTUAL_HOST e LETSENCRYPT_HOST.

      Salve e feche o arquivo.

      Agora, implante o Eclipse Theia, executando:

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

      O resultado final se parecerá com o 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

      Navegue para o domínio que estiver usando para o Eclipse Theia. Seu navegador mostrará um prompt pedindo que você faça login. Você entrará no Eclipse Theia e verá a GUI do seu editor. Você verá também um cadeado indicando que a conexão é segura.

      Interface Gráfica do Usuário (GUI) do Eclipse Theia

      Conclusão

      Agora, você tem o Eclipse Theia, um IDE em nuvem versátil, instalado no seu servidor Ubuntu 18.04, 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-fonte e nos documentos com ele, de maneira independente ou em colaboração com sua equipe. Você também pode tentar compilar sua própria versão do Eclipse Theia se precisar de recursos adicionais. Para obter mais informações sobre como fazer isso, acesse os documentos do Theia.



      Source link

      Como configurar a plataforma de IDE em nuvem Eclipse Theia no Kubernetes da DigitalOcean


      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 criação e 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. Como eles se baseiam nativamente em tecnologias em nuvem, conseguem usar o cluster para realizar tarefas, o que pode exceder bastante o poder e a confiabilidade de um único computador de desenvolvimento.

      A Eclipse Theia é um IDE em nuvem, extensível, que executa em um servidor remoto e pode ser acessada a partir de uma navegador Web. Visualmente, ela foi criada para ter aparência e comportamento semelhantes aos do Microsoft Visual Studio Code, o que significa que ela é compatível com muitas linguagens de programação e tem um layout flexível e um terminal integrado. O que separa a estrutura Eclipse Theia de outros softwares de IDE em nuvem é a sua extensibilidade; ela pode ser modificada com extensões personalizadas, o que permite que você crie um IDE em nuvem adequado às suas necessidades.

      Neste tutorial, você irá configurar a versão padrão da plataforma IDE em nuvem Eclipse Theia no seu cluster do Kubernetes da Digital Ocean e irá expô-lo em seu domínio, protegida com os certificados do Let’s Encrypt e que exige a autenticação do usuário. No final, você terá o Eclipse Theia funcionando no seu cluster do Kubernetes, disponível via HTTPS e que exige que o usuário faça login.

      Pré-requisitos

      • Um cluster do Kubernetes da DigitalOcean com sua conexão configurada como o kubectl padrão. As instruções sobre como configurar o kubectl são mostradas no passo Conectar-se ao seu cluster quando você criá-lo. Para criar um cluster do Kubernetes no DigitalOcean, consulte o tópico sobre Início rápido do Kubernetes.

      • O gerenciador de pacotes Helm instalado em sua máquina local e o Tiller instalado no seu cluster. Para fazer isso, complete os passos 1 e 2 do tutorial Como instalar software nos clusters do Kubernetes com o gerenciador de pacotes do Helm.

      • O Controlador Ingress para Nginx e o Cert-Manager instalados em seu cluster usando o Helm para expor o Eclipse Theia usando os recursos de Ingress. Para fazer isso, siga o tutorial de Como configurar um Nginx Ingress no Kubernetes da DigitalOcean usando o Helm.

      • Um nome de domínio totalmente registrado para hospedar o Eclipse Theia. Este tutorial usará 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.

      Passo 1 — Instalando e expondo o Eclipse Theia

      Para começar, você instalará o Eclipse Theia para seu cluster Kubernetes da DigitalOcean. Então, você irá expô-lo em seu domínio desejado, usando um Nginx Ingress.

      Como você criou duas implantações de exemplo e um recurso como parte dos pré-requisitos, sinta-se livre para deletá-los executando os seguintes comandos:

      • kubectl delete -f hello-kubernetes-ingress.yaml
      • kubectl delete -f hello-kubernetes-first.yaml
      • kubectl delete -f hello-kubernetes-second.yaml

      Para este tutorial, você armazenará a configuração da implantação em sua máquina local, em um arquivo chamado eclipse-theia.yaml​​​. Crie-o usando o seguinte comando:

      Adicione as seguintes linhas ao arquivo:

      eclipse-theia.yaml

      apiVersion: v1
      kind: Namespace
      metadata:
        name: theia
      ---
      apiVersion: networking.k8s.io/v1beta1
      kind: Ingress
      metadata:
        name: theia-next
        namespace: theia
        annotations:
          kubernetes.io/ingress.class: nginx
      spec:
        rules:
        - host: theia.your_domain
          http:
            paths:
            - backend:
                serviceName: theia-next
                servicePort: 80
      ---
      apiVersion: v1
      kind: Service
      metadata:
       name: theia-next
       namespace: theia
      spec:
       ports:
       - port: 80
         targetPort: 3000
       selector:
         app: theia-next
      ---
      apiVersion: apps/v1
      kind: Deployment
      metadata:
        labels:
          app: theia-next
        name: theia-next
        namespace: theia
      spec:
        selector:
          matchLabels:
            app: theia-next
        replicas: 1
        template:
          metadata:
            labels:
              app: theia-next
          spec:
            containers:
            - image: theiaide/theia:next
              imagePullPolicy: Always
              name: theia-next
              ports:
              - containerPort: 3000
      

      Essa configuração define um Namespace, uma implantação, um serviço e um Ingress. O Namespace é chamado de theia e terá todos os objetos do Kubernetes relacionados ao Eclipse Theia, separados do resto do cluster. A implantação consiste em uma instância da imagem do Docker theiaide/theia:next com a porta 3000 exposta no contêiner. O serviço busca a implantação e remapeia a porta do contêiner para a porta usual do HTTP, 80, permitindo acesso de login no cluster ao Eclipse Theia.

      O Ingress contém uma regra para atender o serviço na porta 80 externamente em seu domínio desejado. Em suas anotações, especifique que o Nginx Ingress Controller deve ser usado para o processamento de pedidos. Lembre-se de substituir o theia.your_domain pelo seu domínio desejado, que você apontou para o Balanceador de Carga e, em seguida, salve e feche o arquivo.

      Salve e saia do arquivo.

      Em seguida, crie a configuração no Kubernetes, executando o seguinte comando:

      • kubectl create -f eclipse-theia.yaml

      Você verá o seguinte resultado:

      Output

      namespace/theia created ingress.networking.k8s.io/theia-next created service/theia-next created deployment.apps/theia-next created

      É possível monitorar a criação de pod do Eclipse Theia, executando:

      • kubectl get pods -w -n theia

      O resultado ficará parecido com este:

      Output

      NAME READY STATUS RESTARTS AGE theia-next-847d8c8b49-jt9bc 0/1 ContainerCreating 0 22s

      Após um tempo, o status se tornará RUNNING, o que significa que você instalou com sucesso o Eclipse Theia para o seu cluster.

      Navegue até seu domínio no seu navegador. Você verá a interface padrão GUI do editor do Eclipse Theia.

      A interface padrão GUI do editor Eclipse Theia

      Você implantou o Eclipse Theia para seu cluster Kubernetes da DigitalOcean e o expôs em seu domínio desejado com um Ingress. Em seguida, você protegerá o acesso à sua implantação do Eclipse Theia, possibilitando a autenticação de login.

      Passo 2 — Habilitando a autenticação de login para seu domínio

      Neste passo, você habilitará o nome de usuário e a autenticação de senha para sua implantação do Eclipse Theia. Você conseguirá isso selecionando primeiro uma lista de combinações válidas de login usando o utilitário htpasswd. Então, você criará um segredo do Kubernetes que contém essa lista e configurará o Ingress para autenticar os usuários de acordo com ela. No final, seu domínio só ficará acessível quando o usuário inserir uma combinação de nome de usuário e senha válidos. Isso impedirá que convidados e outros usuários indesejados acessem o Eclipse Theia.

      O utilitário htpasswd vem do servidor Web do Apache e é usado para a criação de arquivos que armazenam listas de combinações de login. O formato dos arquivos htpasswd é uma combinação username:hashed_password​​​ por linha, que é o formato que o Nginx Ingress Controller espera que a lista esteja em conformidade.

      Comece instalando o htpasswd no seu sistema, executando o seguinte comando:

      • sudo apt install apache2-utils -y

      Você armazenará a lista em um arquivo chamado auth. Crie-o executando:

      Este aquivo precisa ser chamado de auth, porque o Nginx Ingress Controller espera que o segredo contenha uma chave chamada de data.auth. Se ela estiver faltando, o controlador retornará o status HTTP 503 Service Unavailable.

      Adicione uma combinação de nome de usuário e senha para o auth, executando o seguinte comando:

      Lembre-se de substituir o username pelo seu nome de usuário desejado. Você será solicitado a colocar uma senha de acompanhamento e a combinação será adicionada no arquivo auth. Você pode repetir esse comando para a quantidade de usuários que quiser adicionar.

      Nota: se o sistema em que está trabalhando não tiver o htpasswd instalado, em vez disso, utilize uma versão convertida para Docker.

      Você precisará ter o Docker instalado em sua máquina. Para obter instruções sobre como fazer isso, visite a documentação oficial.

      Execute o seguinte comando para executar uma versão convertida para o Docker:

      • docker run --rm -it httpd htpasswd -n <username>

      Lembre-se de substituir o <username> pelo nome de usuário que quiser utilizar. Você será solicitado a colocar uma senha. A combinação de login com hash será escrita no console e será necessário adicioná-la manualmente ao final do arquivo auth. Repita este processo para a quantidade de logins que quiser adicionar.

      Quando terminar, crie um novo segredo no Kubernetes com o conteúdo do arquivo, executando o seguinte comando:

      • kubectl create secret generic theia-basic-auth --from-file=auth -n theia

      Você pode ver o segredo com:

      • kubectl get secret theia-basic-auth -o yaml -n theia

      O resultado se parecerá com o seguinte:

      Output

      apiVersion: v1 data: auth: c2FtbXk6JGFwcjEkVFMuSDdyRWwkaFNSNWxPbkc0OEhncmpGZVFyMzEyLgo= kind: Secret metadata: creationTimestamp: "..." name: theia-basic-auth namespace: default resourceVersion: "10900" selfLink: /api/v1/namespaces/default/secrets/theia-basic-auth uid: 050767b9-8823-4fd3-b498-5f11074f768b type: Opaque

      Em seguida, será necessário editar o Ingress para o fazer usar o segredo. Abra a configuração de implantação para edição:

      Adicione as linhas destacadas ao seu arquivo:

      eclipse-theia.yaml

      apiVersion: v1
      kind: Namespace
      metadata:
        name: theia
      ---
      apiVersion: networking.k8s.io/v1beta1
      kind: Ingress
      metadata:
        name: theia-next
        namespace: theia
        annotations:
          kubernetes.io/ingress.class: nginx
          nginx.ingress.kubernetes.io/auth-type: basic
          nginx.ingress.kubernetes.io/auth-secret: theia-basic-auth
          nginx.ingress.kubernetes.io/auth-realm: 'Authentication Required - Eclipse Theia'
      spec:
        rules:
        - host: theia.your_domain
          http:
            paths:
            - backend:
                serviceName: theia-next
                servicePort: 80
      ...
      

      Primeiro, na anotação auth-type, especifique que o tipo de autenticação é basic. Isso significa que o Nginx exigirá que o usuário digite um nome de usuário e senha. Então, em auth-secret, especifique que o segredo que contém a lista de combinações válidas é o theia-basic-auth, que acabou de criar. A anotação auth-realm restante especifica uma mensagem que será mostrada ao usuário como uma explicação do porquê a autenticação é necessária. Você pode alterar a mensagem contida neste campo para uma de sua preferência.

      Salve e feche o arquivo.

      Para propagar as alterações ao seu cluster, execute o seguinte comando:

      • kubectl apply -f eclipse-theia.yaml

      Você verá o resultado:

      Output

      namespace/theia unchanged ingress.networking.k8s.io/theia-next configured service/theia-next unchanged deployment.apps/theia-next unchanged

      Navegue para seu domínio no navegador, onde agora será solicitado que você faça login.

      Você habilitou a autenticação de login básica em seu Ingress, configurando-o para usar o segredo contendo combinações de nome de usuário e senha em hash. No próximo passo, você protegerá o acesso ainda mais, adicionando certificados TLS, de modo que o tráfego entre você e sua implantação do Eclipse Theia fique criptografado.

      Passo 3 — Aplicando certificados HTTPS do Let’s Encrypt

      Em seguida, você protegerá sua instalação do Eclipse Theia, aplicando os certificados do Let’s Encrypt para seu Ingress, que o Cert-Manager provisionará automaticamente. Após completar este passo, sua instalação do Eclipse Theia será acessível via HTTPS.

      Abra o eclipse-theia.yaml​​​ para edição:

      Adicione as linhas destacadas ao seu arquivo, certificando-se de substituir o domínio do espaço reservado pelo seu próprio domínio:

      eclipse-theia.yaml

      apiVersion: v1
      kind: Namespace
      metadata:
        name: theia
      ---
      apiVersion: networking.k8s.io/v1beta1
      kind: Ingress
      metadata:
        name: theia-next
        namespace: theia
        annotations:
          kubernetes.io/ingress.class: nginx
          nginx.ingress.kubernetes.io/auth-type: basic
          nginx.ingress.kubernetes.io/auth-secret: theia-basic-auth
          nginx.ingress.kubernetes.io/auth-realm: 'Authentication Required - Eclipse Theia'
          cert-manager.io/cluster-issuer: letsencrypt-prod
      spec:
        tls:
        - hosts:
          - theia.your_domain
          secretName: theia-prod
        rules:
        - host: theia.your_domain
          http:
            paths:
            - backend:
                serviceName: theia-next
                servicePort: 80
      ...
      

      Primeiro, especifique o ClusterIssuer do letsencrypt-prod que você criou como parte dos pré-requisitos como o emissor que será utilizado para fornecer os certificados para este Ingress. Em seguida, na seção tls, especifique o domínio exato que deve ser protegido, assim como o nome para um segredo que terá esses certificados.

      Salve e saia do arquivo.

      Aplique as alterações no seu cluster executando o seguinte comando:

      • kubectl apply -f eclipse-theia.yaml

      O resultado se parecerá com o seguinte:

      Output

      namespace/theia unchanged ingress.networking.k8s.io/theia-next configured service/theia-next unchanged deployment.apps/theia-next unchanged

      Serão necessários alguns minutos para que os certificados sejam provisionados e aplicados totalmente. Você pode monitorar o progresso, observando o resultado do seguinte comando:

      • kubectl describe certificate theia-prod -n theia

      Quando ele terminar, o final do resultado ficará parecido com este:

      Output

      ... Events: Type Reason Age From Message ---- ------ ---- ---- ------- Normal GeneratedKey 42m cert-manager Generated a new private key Normal Requested 42m cert-manager Created new CertificateRequest resource "theia-prod-3785736528" Normal Issued 42m cert-manager Certificate issued successfully

      Recarregue seu domínio no seu navegador. Você verá um cadeado verde localizado no lado mais à esquerda da barra de endereço indicando que a conexão é segura.

      Você configurou o Ingress para usar os certificados do Let’s Encrypt, tornando assim a implantação do Eclipse Theia mais segura. Agora, você pode revisar a interface padrão de usuário do Eclipse Theia.

      Passo 4 — Usando a interface do Eclipse Theia

      Nesta seção, você irá explorar alguns dos recursos do 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.

      GUI do Eclipse Theia - 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-os conforme necessário.

      Após criar um novo arquivo através do menu File, verá um arquivo vazio aberto em uma nova guia. 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, bem como arrastar e soltar arquivos e pastas nas partes superiores da hierarquia – para movê-los para uma nova localização.

      GUI do Eclipse Theia - Nova Pasta

      As duas opções seguintes fornecem acesso às funções buscar e substituir. Na sequência, a próxima função 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 de depurador, que fornece todas as ações comuns para se obter a depuração no painel. Você pode salvar as configurações de depuração no arquivo launch.json.

      Visualização do Depurador com o launch.json aberto

      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.

      Exibição em Grade do Editor

      Você pode ter acesso a um terminal digitando CTRL+SHIFT+`, ou clicando em Terminal, no menu superior e selecionando a opção 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.

      Terminal aberto

      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, uma IDE em nuvem versátil, instalada no seu cluster do Kubernetes da DigitalOcean. Você o protegeu com um certificado TLS do Let’s Encrypt gratuito e configurou a instância para exigir o login do usuário. Você pode trabalhar no seu código-fonte e nos documentos com ele, de maneira independente ou em colaboração com sua equipe. Você também pode tentar compilar sua própria versão do Eclipse Theia se precisar de recursos adicionais. Para obter mais informações sobre como fazer isso, acesse os documentos do Theia.



      Source link