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:

nano eclipse-theia.yaml

Añada las líneas siguientes al archivo:

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.

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:

touch auth

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:

htpasswd auth username

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.

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

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:

nano eclipse-theia.yaml

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

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:

nano eclipse-theia.yaml

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

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.

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.

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.

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.

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.

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.