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

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.

• 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.

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:

nano eclipse-theia.yaml

Adicione as seguintes linhas ao arquivo:

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.

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.

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:

touch auth

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:

htpasswd auth username

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.

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

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:

nano eclipse-theia.yaml

Adicione as linhas destacadas ao seu arquivo:

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.

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:

nano eclipse-theia.yaml

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

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.

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.

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.

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.

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 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.

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

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.