Comment configurer la plate-forme Eclipse Theia Cloud IDE sur DigitalOcean Kubernetes

L’auteur a choisi le Free and Open Source Fund pour recevoir une donation dans le cadre du programme Write for DOnations.

Introduction

Avec la migration des outils de développement vers le cloud, la création et l’adoption de plateformes IDE (Integrated Development Environment) en nuage se développent. Les IDE cloud sont accessibles depuis chaque type de dispositif moderne via les navigateurs web, et ils offrent de nombreux avantages pour les scénarios de collaboration en temps réel. Travailler dans un IDE cloud fournit un environnement de développement et de test unifié pour vous et votre équipe, tout en minimisant les incompatibilités de plate-forme. Parce qu’ils sont basés nativement sur les technologies cloud, ils sont capables d’utiliser le cluster pour réaliser des tâches qui peuvent largement dépasser la puissance et la fiabilité d’un seul ordinateur de développement.

Eclipse Theia est un IDE cloud extensible fonctionnant sur un serveur distant et accessible depuis un navigateur web. Visuellement, il est conçu pour ressembler et se comporter de manière similaire à Microsoft Visual Studio Code, ce qui signifie qu’il prend en charge de nombreuses langues de programmation, dispose d’un schéma flexible et d’un terminal intégré. Ce qui différencie Eclipse Theia d’autres logiciels IDE cloud est son extensibilité ; il peut être modifié en utilisant des extensions personnalisées, ce qui vous permet de créer un IDE cloud adapté à vos besoins.

Dans ce tutoriel, vous allez configurer la version par défaut de la plateforme Eclipse Theia cloud IDE sur votre cluster DigitalOcean Kubernetes et l’exposer à votre domaine, sécurisé par des certificats Let’s Encrypt et exigeant que le visiteur s’authentifie. Au bout du compte, vous disposerez d’Eclipse Theia sur cluster Kubernetes, disponible via HTTPS et exigeant que le visiteur se connecte.

Conditions préalables

• Un cluster DigitalOcean Kubernetes avec votre connexion configurée comme kubectl par défaut. Les instructions sur la façon de configurer kubectl sont indiquées dans l’étape Se connecter à votre cluster lorsque vous créez votre cluster. Pour créer un cluster Kubernetes sur DigitalOcean, voir notre Kubernetes Quickstart.

• Le gestionnaire de paquets Helm installé sur votre machine locale, et Tiller installé sur votre cluster. Pour ce faire, suivez les étapes 1 et 2 du tutoriel Comment installer un logiciel sur les clusters de Kubernetes avec le gestionnaire de paquets de Helm.

• Le Nginx Ingress Controller et le Cert Manager installés sur votre cluster en utilisant Helm afin d’exposer Eclipse Theia en utilisant Ingress Resources. Pour ce faire, suivez Comment configurer une entrée Nginx sur DigitalOcean Kubernetes en utilisant Helm.

• Un nom de domaine entièrement enregistré pour héberger Eclipse Theia. Ce tutoriel utilisera theia.your-domain tout au long du cours. Vous pouvez acheter un nom de domaine sur Namecheap, en obtenir un gratuitement sur Freenom, ou utiliser le bureau d’enregistrement de domaine de votre choix.

Étape 1 — Installation et exposition d’Eclipse Theia

Pour commencer, vous allez installer Eclipse Theia sur votre cluster DigitalOcean Kubernetes. Ensuite, vous allez l’exposer au domaine de votre choix en utilisant une entrée Nginx.

Comme vous avez créé deux exemples de déploiements et une ressource comme faisant partie des conditions préalables, vous pouvez les supprimer librement en exécutant les commandes suivantes :

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

Pour les besoins de ce tutoriel, vous allez stocker la configuration du déploiement sur votre machine locale, dans un fichier nommé eclipse-theia.yaml. Créez-le en utilisant la commande suivante :

nano eclipse-theia.yaml

Ajoutez les lignes suivantes au fichier :

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

Cette configuration définit un espace de noms, un déploiement, un service et une Ingress (entrée réseau). L’espace de noms est appelé theia et contiendra tous les objets Kubernetes liés à Eclipse Theia, séparés du reste du cluster. Le déploiement consiste en un exemple de l’image Docker theiaide/theia:next avec le port 3000 exposé sur le conteneur. Le service recherche le déploiement et renvoie le port conteneur au port HTTP habituel, 80, permettant l’accès in-cluster à Eclipse Theia.

L’Ingress contient une règle pour servir le service au port 80 en externe sur le domaine de votre choix. Dans ses annotations, vous spécifiez que le Nginx Ingress Controller doit être utilisé pour le traitement de la requête. N’oubliez pas de remplacer theia.votre_domaine par le domaine souhaité (que vous avez pointé vers l’équilibreur de charge de votre cluster), puis enregistrez et fermez le fichier.

Enregistrez et quittez le fichier.

Ensuite, créez la configuration dans Kubernetes en exécutant la commande suivante :

kubectl create -f eclipse-theia.yaml

Vous verrez la sortie suivante :

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

Vous pouvez voir la création du module Eclipse Theia en exécutant :

kubectl get pods -w -n theia

La sortie finale ressemblera à ceci :

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

Après un certain temps, le statut va passer à RUNNING, ce qui signifie que vous avez bien installé Eclipse Theia sur votre cluster.

Naviguez vers votre domaine dans votre navigateur. Vous verrez l’interface graphique par défaut de l’éditeur Eclipse Theia.

Vous avez déployé Eclipse Theia sur votre cluster Kubernetes DigitalOcean et l’avez exposé au domaine de votre choix avec une Ingress. Ensuite, vous allez sécuriser l’accès à votre déploiement Eclipse Theia en activant l’authentification de la connexion.

Étape 2 — Activation de l’authentification de la connexion pour votre domaine

Dans cette étape, vous allez activer l’authentification du nom d’utilisateur et du mot de passe pour le déploiement d’Eclipse Theia. Vous y parviendrez en établissant d’abord une liste de combinaisons de connexion valides à l’aide de l’utilitaire htpasswd. Ensuite, vous créerez un secret Kubernetes contenant cette liste et configurerez l’entrée pour authentifier les visiteurs en fonction de celle-ci. En fin de compte, votre domaine ne sera accessible que lorsque le visiteur entrera une combinaison de nom d’utilisateur et de mot de passe valide. Cela empêchera les invités et autres visiteurs indésirables d’accéder à Eclipse Theia.

L’utilitaire htpasswd vient du serveur web Apache et est utilisé pour créer des fichiers qui stockent les listes des combinaisons d’identifiants. Le format des fichiers htpasswd est une combinaison username:hashed_password par ligne, ce qui correspond au format attendu par le Nginx Ingress Controller pour la liste.

Commencez par installer htpasswd sur votre système en exécutant la commande suivante :

sudo apt install apache2-utils -y

Vous allez stocker la liste dans un fichier appelé auth. Créez-le en exécutant :

touch auth

Ce fichier doit être nommé auth parce que le Nginx Ingress Controller s’attend à ce que le secret contienne une clé appelée data.auth. S’il est manquant, le contrôleur renverra l’état HTTP 503 Service Indisponible.

Ajoutez une combinaison nom d’utilisateur et mot de passe à auth en exécutant la commande suivante :

htpasswd auth username

N’oubliez pas de remplacer username par le nom d’utilisateur de votre choix. Un mot de passe vous sera demandé et la combinaison sera ajoutée dans le fichier auth. Vous pouvez répéter cette commande pour le nombre d’utilisateurs que vous souhaitez ajouter.

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

Lorsque vous avez terminé, créez un nouveau secret dans Kubernetes avec le contenu du fichier, en exécutant la commande suivante :

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

Vous pouvez voir le secret avec :

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

La sortie ressemblera à :

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

Ensuite, vous devrez modifier l’Ingress pour qu’elle utilise le secret. Ouvrez la configuration du déploiement pour modification :

nano eclipse-theia.yaml

Ajoutez les lignes surlignées à votre fichier :

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

Tout d’abord, dans l’annotation auth-type​​​1​​​, vous spécifiez que le type d’authentification est basic. Cela signifie que Nginx demandera à l’utilisateur de saisir un nom d’utilisateur et un mot de passe. Ensuite, dans auth-secret, vous spécifiez que le secret qui contient la liste des combinaisons valables est theia-basic-auth, que vous venez de créer. L’annotation auth-realm restante spécifie un message qui sera montré à l’utilisateur pour expliquer pourquoi l’authentification est nécessaire.  Vous pouvez changer le message contenu dans ce champ à votre convenance.

Enregistrez et fermez le fichier.

Pour propager les changements à votre cluster, exécutez la commande suivante :

kubectl apply -f eclipse-theia.yaml

Vous verrez la sortie :

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

Accédez à votre domaine dans votre navigateur, où il vous sera demandé de vous connecter.

Vous avez activé l’authentification de base sur votre Ingress en le configurant pour utiliser le secret contenant les combinaisons hachées de nom d’utilisateur et de mot de passe. Dans l’étape suivante, vous allez sécuriser davantage l’accès en ajoutant des certificats TLS, afin que le trafic entre vous et votre déploiement Eclipse Theia reste crypté.

Étape 3 — Appliquer les certificats HTTPS Let’s Encrypt

Maintenant,vous allez sécuriser votre installation Eclipse Theia en appliquant des certificats Let’s Encrypt à votre Ingress, que Cert-Manager fournira automatiquement. Après avoir terminé cette étape, votre installation Eclipse Theia sera accessible via HTTPS.

Ouvrez eclipse-theia.yaml​​​​ pour le modifier :

nano eclipse-theia.yaml

Ajoutez les lignes surlignées à votre fichier, en veillant à remplacer l’espace réservé au domaine par le vôtre :

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

Tout d’abord, vous spécifiez le ClusterIssuer letsencrypt-prod que vous avez créé dans le cadre des conditions préalables en tant qu’émetteur ; il sera utilisé dans le but de fournir des certificats pour cette Ingress. Ensuite, dans la section tls, vous spécifiez le domaine exact qui doit être sécurisé, ainsi qu’un nom pour un secret qui détiendra ces certificats.

Enregistrez et quittez le fichier.

Appliquez les changements à votre cluster en exécutant la commande suivante :

kubectl apply -f eclipse-theia.yaml

La sortie ressemblera à :

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

Il faudra quelques minutes pour que les certificats soient provisionnés et entièrement appliqués. Vous pouvez suivre les progrès en observant la sortie de la commande suivante :

kubectl describe certificate theia-prod -n theia

Lorsque ce sera terminé, la fin de la sortie ressemblera à ceci :

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

Rafraîchissez votre domaine dans votre navigateur. Vous verrez un cadenas vert à l’extrémité gauche de la barre d’adresse, ce qui signifie que la connexion est sécurisée.

Vous avez configuré l’Ingress pour utiliser les certificats Let’s Encrypt, ce qui rend votre déploiement Eclipse Theia plus sécurisé. Vous pouvez maintenant revoir l’interface utilisateur par défaut d’Eclipse Theia.

Étape 4 — Utilisation de l’interface d’Eclipse Theia

Dans cette section, vous allez explorer certaines des caractéristiques de l’interface d’Eclipse Theia.

Sur le côté gauche de l’IDE, se trouve une rangée verticale de quatre boutons qui ouvrent les caractéristiques les plus couramment utilisées dans un panneau latéral.

Cette barre est personnalisable, de sorte que vous pouvez modifier l’ordre de ces vues ou les retirer de la barre. Par défaut, la première vue ouvre le panneau de l’explorateur, qui permet une navigation arborescente de la structure du projet. Vous pouvez gérer vos dossiers et fichiers ici - en les créant, les supprimant, les déplaçant et les renommant si nécessaire.

Après avoir créé un nouveau fichier via le menu Fichier, vous verrez un fichier vide ouvert dans un nouvel onglet. Une fois que vous l’aurez enregistré, vous pourrez visualiser son nom dans le panneau latéral de l’explorateur. Pour créer des dossiers, faites un clic droit sur la barre latérale de l’explorateur et cliquez sur Nouveau dossier. Vous pouvez développer un dossier en cliquant sur son nom ainsi qu’en glissant et déposant des fichiers et des dossiers dans les parties supérieures de la hiérarchie afin de les déplacer vers un nouvel emplacement.

Les deux options suivantes donnent accès à la fonctionnalité de recherche et de remplacement. La suivante donne un aperçu des systèmes de contrôle de source que vous pourriez utiliser, tels que Git.

La vue finale est l’option de débogage, qui fournit toutes les actions courantes de débogage dans le panneau. Vous pouvez enregistrer des configurations de débogage dans le fichier launch.json

La partie centrale de l’interface graphique est votre éditeur, que vous pouvez séparer en onglets pour éditer votre code. Vous pouvez modifier votre vue d’édition en un système de grille ou en fichiers côte à côte. Comme tous les IDE modernes, Eclipse Theia prend en charge la surbrillance syntaxique de votre code.

Vous pouvez accéder à un terminal en tapant CTRL+SHIFT+` ou en cliquant sur Terminal dans le menu supérieur, et en sélectionnant Nouveau terminal. Le terminal s’ouvrira dans un panneau inférieur et son répertoire de travail sera défini sur l’espace de travail du projet, qui contient les fichiers et les dossiers affichés dans le panneau latéral de l’explorateur.

Vous avez exploré un aperçu de haut niveau de l’interface Eclipse Theia et examiné certaines des caractéristiques les plus couramment utilisées.

Conclusion

Vous disposez maintenant d’Eclipse Theia, un IDE cloud polyvalent, installé sur votre cluster DigitalOcean Kubernetes. Vous l’avez sécurisé avec un certificat gratuit Let’s Encrypt TLS et vous avez configuré l’instance de façon à exiger des identifiants de connexion de la part du visiteur. Vous pouvez travailler avec lui sur votre code source et vos documents individuellement ou collaborer avec votre équipe. Vous pouvez également essayer de développer votre propre version d’Eclipse Theia si vous avez besoin de fonctionnalités supplémentaires. Pour plus d’informations sur la façon de procéder, consultez les docs Theia.