One place for hosting & domains

      plataforma

      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

      Cómo configurar la plataforma de IDE en la nube de Eclipse Theia en Kubernetes de DigitalOcean


      El autor seleccionó la Free and Open Source Fund para recibir una donación como parte del programa Write for DOnations.

      Introducción

      Con el traslado de las herramientas de desarrollo a la nube, la creación y la adopción de plataformas de IDE (entorno de desarrollo integrado) en la nube se encuentra en expansión. Los IDE en la nube, a los cuales se puede acceder desde cualquier tipo de dispositivo moderno a través de los navegadores web, ofrecen numerosas ventajas para casos de colaboración en tiempo real. Trabajar en un IDE en la nube permite disponer de un entorno unificado de desarrollo y pruebas para usted y su equipo, a la vez que minimiza las incompatibilidades en la plataforma. Debido a que se basan de forma nativa en tecnologías aplicadas a la nube, pueden usar el clúster para realizar tareas. Esto puede superar en gran medida la potencia y la fiabilidad de una sola computadora de desarrollo.

      Eclipse Theia es un IDE en la nube extensible que se ejecuta en un servidor remoto y al que es posible acceder desde un navegador web. Desde el punto de vista visual, está diseñado para que luzca y se comporte de manera similar a Microsoft Visual Studio Code, lo cual significa que es compatible con muchos lenguajes de programación, tiene un diseño flexible y cuenta con una terminal integrada. Lo que diferencia a Eclipse Theia de otras plataformas de software de IDE en la nube es su extensibilidad; se puede modificar usando extensiones personalizadas, que le permiten crear un IDE en la nube adaptado a sus necesidades.

      A través de este tutorial, configurará la versión predeterminada de la plataforma de IDE en la nube de Eclipse Theia en su clúster de Kubernetes de DigitalOcean y lo expondrá en su dominio, protegido con certificados de Let´s Encrypt y con el requisito de que se autentique. Al finalizar, dejará Eclipse Theia en ejecución en su clúster de Kubernetes, disponible a través de HTTPS, y hará que solicite iniciar sesión a los visitantes.

      Requisitos previos

      • Un clúster de Kubernetes de DigitalOcean con su conexión configurada como kubectl predeterminado. Verá las instrucciones para configurar kubectl en el paso Establecer conexión con su clúster cuando cree su clúster. Para crear un clúster de Kubernetes en DigitalOcean, consulte Guía rápida de Kubernetes.

      • El administrador de paquetes de Helm instalado en su computadora local y Tiller instalado en su clúster. Para hacerlo, complete los pasos 1 y 2 del tutorial Cómo instalar software en clústeres de Kubernetes con el administrador de paquetes de Helm.

      • El controlador de entrada Nginx y Cert-Manager instalados en su clúster usando Helm para exponer Eclipse Theia a través de recursos de entrada. Para hacerlo, siga el artículo Cómo configurar un Ingress de Nginx en Kubernetes de DigitalOcean usando Helm.

      • Un nombre de dominio registrado por completo para alojar Eclipse Theia. Para este tutorial, se utilizará theia.your_domain en todo momento. Puede adquirir un nombre de dominio en Namecheap, obtener uno gratuito en Freenom o utilizar un registrador de dominios que elija.

      Paso 1: Instalar y exponer Eclipse Theia

      Para comenzar, instalará Eclipse Theia en su clúster de Kubernetes de DigitalOcean. Luego, lo expondrá en el dominio que desee usando una entrada de Nginx.

      Debido a que creó dos implementaciones de ejemplo y un recurso como parte de los requisitos previos, puede eliminarlos libremente ejecutando los siguientes comandos:

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

      A los efectos de este tutorial, almacenará la configuración de implementación en su equipo local, en un archivo denominado eclipse-theia.yaml. Créelo usando el siguiente comando:

      Añada las líneas siguientes al archivo:

      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
      

      Esta configuración define un espacio de nombres, una implementación, un servicio y un Ingress. El espacio de nombres se denomina theia y contendrá todos los objetos de Kubernetes relacionados con Eclipse Theia, separados del resto del clúster. La implementación consta de una instancia de la imagen de Docker theiade/theia:next con el puerto 3000 expuesto en el contenedor. El servicio busca la implementación y reasigna el puerto del contenedor al puerto HTTP habitual, 80, lo que permite el acceso a Eclipse Theia en el clúster.

      La entrada contiene una regla para proporcionar el servicio en el puerto 80 de forma externa en su dominio deseado. En sus anotaciones, especificará que el controlador de entrada de Nginx debe utilizarse para el procesamiento de solicitudes. Recuerde sustituir theia.your_domain por el dominio que desee, al que haya apuntado el equilibrador de carga de su clúster. A continuación, guarde y cierre el archivo.

      Guarde el archivo y ciérrelo.

      A continuación, cree la configuración en Kubernetes ejecutando el siguiente comando:

      • kubectl create -f eclipse-theia.yaml

      Verá el siguiente resultado:

      Output

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

      Puede ver la creación de pod de Eclipse Theia al ejecutar lo siguiente:

      • kubectl get pods -w -n theia

      El resultado tendrá el siguiente aspecto:

      Output

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

      Después de un tiempo, el estado cambiará a RUNNING, lo cual significa que instaló Eclipse Theia correctamente en su clúster.

      Diríjase a su dominio en su navegador. Verá la GUI del editor de Eclipse Theia predeterminado.

      GUI predeterminada del editor de Eclipse Theia

      Implementó Eclipse Theia en su clúster de Kubernetes de DigitalOcean y lo expuso en su dominio deseado con una entrada. A continuación, protegerá el acceso a su implementación de Eclipse Theia habilitando la autenticación de inicio de sesión.

      Paso 2: Habilitar la autenticación de inicio de sesión de su dominio

      En este paso, habilitará la autenticación de nombre de usuario y contraseña para su implementación de Eclipse Theia. Para hacerlo, primero confeccionará una lista seleccionada con las combinaciones de inicio de sesión válidas mediante la utilidad htpasswd. Luego, creará un secreto de Kubernetes que contendrá esa lista y configurará la entrada para autenticar a los visitantes de acuerdo con ella. Al final, solo se podrá acceder a su dominio cuando un visitante ingrese una combinación de nombre de usuario y contraseña válida. Esto evitará que invitados y visitantes no deseados accedan a Eclipse Theia.

      La herramienta htpasswd proviene del servidor web Apache y se utiliza para crear archivos que contienen listas de combinaciones de inicio de sesión. El formato de los archivos htpasswd es una combinación de username:hashed_password por línea y es el formato con el cual el controlador de entrada de Nginx prevé que la lista cumplirá.

      Comience instalando htpasswd en su sistema con el siguiente comando:

      • sudo apt install apache2-utils -y

      Almacenará la lista en un archivo llamado auth. Créelo ejecutando lo siguiente:

      Este archivo debe llevar el nombre auth, ya que el controlador de entrada de Nginx espera que contenga una clave llamada data.auth. Si no está presente, el controlador mostrará el estado de error HTTP 503 de servicio no disponible.

      Añada una combinación de nombre de usuario y contraseña a auth ejecutando el siguiente comando:

      Recuerde sustituir username por el nombre de usuario que desee. Se le solicitará una contraseña complementaria y la combinación se agregará en el archivo auth. Puede repetir este comando para todos los usuarios que desee añadir.

      Nota: Si el sistema en el que trabaja no tiene htpasswd instalado, puede usar una versión procesada con Docker en su lugar.

      Deberá tener Docker instalado en su equipo. Para hallar instrucciones sobre cómo hacerlo, consulte la documentación oficial.

      Ejecute el siguiente comando para ejecutar una versión dockerizada:

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

      Recuerde sustituir username por el nombre de usuario que desea usar. Se le solicitará una contraseña. La combinación de inicio de sesión con hash se escribirá en la consola y deberá añadirla manualmente al final del archivo auth. Repita este proceso para todos los inicios de sesión que desee añadir.

      Cuando termine, cree un nuevo secreto en Kubernetes con el contenido del archivo al ejecutar el siguiente comando:

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

      Puede ver el secreto con lo siguiente:

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

      El resultado tendrá este aspecto:

      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

      A continuación, deberá editar la entrada para hacer que utilice el secreto. Abra la configuración de la implementación para editarla:

      Añada las líneas resaltadas a su archivo:

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

      Primero, en la anotación de auth-type, especifique que el tipo de autenticación es basic. Esto significa que Nginx exigirá al usuario ingresar un nombre de usuario y una contraseña. Luego, en auth-secret, especifique que el secreto que contiene la lista de combinaciones válidas es theia-basic-auth, lo que acaba de crear. En la anotación de auth-realm restante se especifica un mensaje que se mostrará al usuario para explicar por qué se requiere la autenticación. Puede cambiar el mensaje de este campo a su gusto.

      Guarde y cierre el archivo.

      Para propagar los cambios a su clúster, ejecute el siguiente comando:

      • kubectl apply -f eclipse-theia.yaml

      Verá el resultado:

      Output

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

      Diríjase a su dominio en su navegador, donde se le solicitará iniciar sesión.

      Habilitó la autenticación básica de inicio de sesión en su entrada configurándola para que use el secreto que contiene las combinaciones de nombre de usuario y contraseña con hash. En el siguiente paso, protegerá el acceso aún más añadiendo certificados TLS para mantener cifrado el tráfico entre usted y su implementación de Eclipse Theia sea cifrado.

      Paso 3: Aplicar certificados HTTPS de Let´s Encrypt

      A continuación, protegerá su instalación de Eclipse Theia aplicando certificados de Let´s Encrypt a su entrada, que Cert-Manager proporcionará de forma automática. Una vez completado este paso, será posible acceder a su instalación de Eclipse Theia a través de HTTPS.

      Abra eclipse-theia.yaml para editarlo:

      Añada las líneas resaltadas a su archivo. Asegúrese de sustituir el marcador de posición del dominio por el suyo:

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

      Primero, especifique el ClusterIssuer letsencrypt-prod, que creó como parte de los requisitos previos, como el emisor que se usará para proporcionar certificados para este Ingress. Luego, en la sección tls, especifique el dominio exacto que se debe proteger, así como el nombre del secreto que contendrá esos certificados.

      Guarde el archivo y ciérrelo.

      Aplique los cambios a su clúster al ejecutar el siguiente comando:

      • kubectl apply -f eclipse-theia.yaml

      El resultado tendrá este aspecto:

      Output

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

      El suministro y la aplicación total de los certificados tomará unos minutos. Puede hacer un seguimiento del progreso observando el resultado del siguiente comando:

      • kubectl describe certificate theia-prod -n theia

      Cuando termine, la parte final del resultado tendrá un aspecto similar a 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

      Actualice su dominio en su navegador. En el extremo izquierdo de la barra de direcciones, verá un candado verde que indica que la conexión es segura.

      Configuró la entrada para que use certificados de Let´s Encrypt y, de esta manera, hizo que su implementación de Eclipse Theia sea más segura. Ahora, puede revisar la interfaz de usuario de Eclipse Theia predeterminada.

      Paso 4: Usar la interfaz de Eclipse Theia

      En esta sección, conocerá algunas de las características de la interfaz de Eclipse Theia.

      Del lado izquierdo del IDE, hay una fila vertical con cuatro botones que abren las funciones utilizadas con mayor frecuencia en el panel lateral.

      GUI de Eclipse Theia: panel lateral

      Esta barra es personalizable, para que pueda cambiar el orden de estas vistas o eliminarlas de ella. De forma predeterminada, la primera vista abre el panel de Explorer que permite explorar la estructura del proyecto con forma de árbol. Aquí, puede administrar sus carpetas y archivos. Esto incluye crear, eliminar, mover y modificar nombres según sea necesario.

      Después de crear un nuevo archivo a través del menú File, verá un archivo vacío abierto en una nueva pestaña. Una vez que lo guarde, podrá ver el nombre en el panel lateral de Explorer. Para crear carpetas, haga clic en la barra lateral de Explorer y luego en New Folder. Puede expandir una carpeta haciendo clic en su nombre, y también arrastrando archivos y carpetas y soltándolos en partes superiores de la jerarquía para trasladarlas a una nueva ubicación.

      GUI de Eclipse Theia: New Folder

      Las siguientes dos opciones proporcionan acceso a la funcionalidad de búsqueda y reemplazo. La que sigue presenta una vista de los sistemas de control de fuentes que puede estar utilizando, como Git.

      La vista final es la opción de depuración, que ofrece todas las acciones comunes para realizar depuraciones en el panel. Puede guardar las configuraciones de depuración en el archivo launch.json.

      Vista del depurador con launch.json abierto

      La parte central de la GUI es su editor, que usted puede separar por pestañas para editar su código. Puede cambiar la vista de edición a un sistema de cuadrícula o a archivos en paralelo. Al igual que en todos los IDE modernos, en Eclipse Theia se admite el resalte de sintaxis para su código.

      Vista de sistema de cuadrícula

      Puede obtener acceso a un terminal presionando CTRL+SHIFT+ o seleccionando Terminal en el menú superior y luego New Terminal. La terminal se abrirá en un panel inferior y su directorio de trabajo fijará en el espacio de trabajo del proyecto, que contiene los archivos y las carpetas que se muestran en el panel lateral de Explorer.

      Terminal abierto

      Pudo ver una descripción general de alto nivel de la interfaz de Eclipse Theia y revisó algunas de las características más utilizadas.

      Conclusión

      De esta manera, tendrá Eclipse Theia, un IDE en la nube versátil, instalado en su clúster de Kubernetes de DigitalOcean. Lo protegió con un certificado TLS gratuito de Let´s Encrypt y configuró la instancia para que exija las credenciales de inicio de sesión de los visitantes. Con él puede trabajar en su código fuente y sus documentos de forma individual o colaborar con su equipo. También puede intentar crear su propia versión de Eclipse Theia si necesita funciones adicionales. Para obtener más información sobre cómo hacerlo, consulte la documentación de 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