Настройка облачной IDE-платформы Eclipse Theia на DigitalOcean Kubernetes

По мере перемещения инструментов для разработчиков в облако, появляется все большее количество облачных IDE (интегрированная среда разработки), и все большее количество разработчиков начинает их использовать. Облачные IDE доступны на всех видах современных устройств посредством веб-браузеров и предлагают многочисленные преимущества для сценариев взаимодействия в реальном времени. Работа в облачной IDE обеспечивает единую среду разработки и тестирования для вас и вашей команды, минимизируя возможную несовместимость платформ. Поскольку они по умолчанию опираются на облачные технологии, это позволяет использовать кластер для выполнения задач, которые могут значительно повышать надежность и возможности отдельного компьютера, используемого для разработки.

Eclipse Theia — это расширяемая облачная IDE, запущенная на удаленном сервере и доступная в браузере. Визуально она выглядит и ведет себя аналогично Microsoft Visual Studio Code, что означает, что эта среда для разработки поддерживает различные языки программирования, имеет гибкий интерфейс и встроенный терминал. Отличие Eclipse Theia от других облачных IDE состоит в возможности расширения; ее можно изменять с помощью пользовательских расширений, что позволяет получить облачную IDE, настроенную под ваши нужды.

В этом обучающем модуле мы настроим используемую по умолчанию версию облачной IDE-платформы Eclipse Theia на вашем кластере DigitalOcean Kubernetes и разместим ее на домене, обеспечим защиту с помощью сертификатов Let’s Encrypt и организуем обязательную аутентификацию для посетителей. В результате на нашем кластере Kubernetes будет запущена платформа Eclipse Theia, доступная через протокол HTTPS и требующая ввода учетных данных пользователя для входа.

• Кластер DigitalOcean Kubernetes с вашим подключением, настроенным с помощью kubectl по умолчанию. Инструкции по настройке kubectl описаны в шаге Подключение кластера, посвященном созданию вашего кластера. Процесс создания кластера Kubernetes в DigitalOcean, см. Быстрое начало работы с Kubernetes.

• Менеджер пакетов Helm, установленный на локальном компьютере, и Tiller, установленный на кластере. Для этого нужно выполнить шаги 1 и 2 руководства Установка программного обеспечения на кластеры Kubernetes с помощью менеджера пакетов Helm.

• Nginx Ingress-контроллер и Cert-Manager, установленные на вашем кластере с помощью Helm, для предоставления Eclipse Theia с помощью ресурсов Ingress. См. руководство Настройка Nginx Ingress на DigitalOcean Kubernetes с помощью Helm для выполнения необходимых действий.

• Полное зарегистрированное доменное имя для хостинга Eclipse Theia. В этом обучающем руководстве мы будем использовать имя theia.your_domain. Вы можете купить доменное имя на Namecheap, получить его бесплатно на Freenom или воспользоваться услугами любого предпочитаемого регистратора доменных имен.

Для начала мы установим Eclipse Theia на кластер DigitalOcean Kubernetes. Затем вам нужно будет разместить ее на желаемом домене с помощью Nginx Ingress.

После создания двух примеров развертывания и ресурсов согласно предварительным требованиям, вы можете свободно удалить их с помощью следующих команд:

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

Вы должны будете сохранить конфигурацию развертывания на локальном компьютере в файле с именем eclipse-theia.yaml. Создайте файл с помощью следующей команды:

nano 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

Эта конфигурация определяет пространство имен, развертывание и службы, а также Ingress. Пространство имен называется theia и будет содержать все объекты Kubernetes, связанные с Eclipse Theia, отдельно от остального кластера. Развертывание содержит один экземпляр образа Docker theiaide/theia:next с портом 3000, размещенный в контейнере. Служба ищет развертывание и перераспределяет порт контейнера на обычный порт HTTP, 80, позволяющий получить доступ к Eclipse Theia внутри кластера.

Ingress содержит правило для обслуживания службы через порт 80 внешне на вашем желаемом домене. В аннотациях необходимо указать, что Nginx Ingress-контроллер должен использоваться для обработки запросов. Не забудьте заменить theia.your_domain на желаемый домен, который вы указали в балансировщике нагрузки вашего кластера, после чего сохраните и закройте файл.

Сохраните и закройте файл.

Затем создайте конфигурацию в Kubernetes с помощью следующей команды:

kubectl create -f eclipse-theia.yaml

Вывод должен выглядеть так:

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

Вы можете наблюдать за создание пода Eclipse Theia с помощью следующей команды:

kubectl get pods -w -n theia

Итоговый результат будет выглядеть следующим образом:

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

Через некоторое время статус поменяется на RUNNING, что означает, что вы успешно установили Eclipse Theia в ваш кластер.

Перейдите на ваш домен в браузере. Вы увидите используемый по умолчанию графический интерфейс Eclipse Theia.

Вы развернули Eclipse Theia в вашем кластере DigitalOcean Kubernetes и разместили его на желаемом домене с помощью Ingress. Далее вам необходимо защитить доступ к развертыванию Eclipse Theia, реализовав аутентификацию при входе.

На данном шаге вы активируете ​​аутентификацию по имени пользователя и паролю для развертывания Eclipse Theia. Вы сможете выполнить эту задачу, сначала создав список действительных комбинаций логина с помощью утилиты htpasswd. Далее создайте секрет Kubernetes, содержащий этот список, и настройте Ingress для аутентификации пользователей согласно этому секрету. В результате ваш домен будет доступен только при вводе посетителем действительного имени пользователя и пароля. Это предотвратить доступ гостей и прочих нежелательных посетителей к Eclipse Theia.

Утилита htpasswd поставляется с веб-сервером Apache и используется для создания файлов, хранящих списки комбинаций данных, используемых для входа. Файлы htpasswd содержит по одной комбинации username:hashed_password​​ на строку, что соответствует ожидаемому Nginx Ingress-контроллером формату.

Начнем с установки htpasswd при помощи следующей команды:

sudo apt install apache2-utils -y

Вы сохраните список в файле с именем auth. Воспользуйтесь следующей командой для создания файла:

touch auth

Этот файл необходимо назвать auth, так как Nginx Ingress-контроллер ожидает, что секрет содержит ключ с названием data.auth​​. Если он отсутствует, контроллер будет возвращать статус HTTP 503 Сервис недоступен.

Добавьте комбинацию имени пользователя и пароля в auth, запустив следущую команду:

htpasswd auth username

Обязательно замените username на желаемое имя пользователя. Вам будет предложено ввести соответствующий пароль, а комбинация будет добавлена в файл auth. Вы можете повторить эту команду, добавив необходимое количество пользователей.

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

После выполнения этих действий создайте новый секрет в Kubernetes с содержимым файла, запустив следующую команду:

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

Вы можете просмотреть секрет с помощью следующей команды:

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

Вывод будет выглядеть следующим образом:

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

Далее вам потребуется изменить Ingress, чтобы он смог использовать секрет. Откройте конфигурацию развертывания для редактирования:

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

Во-первых, в аннотации auth-type вы должны указать, что используемый тип аутентификации является базовым. Это означает, что Nginx будет требовать от пользователя имя пользователя и пароль. Затем в auth-secret необходимо указать, что секрет, содержащий список действительных комбинаций, представляет собой theia-basic-auth, который вы только что создали. Остальная аннотация auth-realm указывает сообщение, которое будет отображаться для пользователя для объяснения необходимости аутентификации. Вы можете изменить сообщение, содержащееся в этом поле, на ваше усмотрение.

Сохраните и закройте файл.

Чтобы изменения вступили в силу в кластере, выполните следующую команду:

kubectl apply -f eclipse-theia.yaml

Результат должен выглядеть так:

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

Перейдите на ваш домен в браузере, который теперь требует ввода данных для входа.

Вы активировали базовую аутентификацию для входа в Ingress, выполнив настройку для использования секрета, содержащего хэшированные комбинации имени пользователя и пароля. На следующем шаге вы обеспечите дополнительную защиту, добавив сертификаты TLS, чтобы трафик между вами и вашим развертыванием Eclipse Theia передавался в зашифрованному виде.

Далее вы обеспечите защиту вашей установки Eclipse Theia, применив сертификаты Let’s Encrypt для Ingress, а Cert-Manager будет автоматически предоставлять эти сертификаты. После выполнения этого шага ваша установка Eclipse Theia будет доступна через HTTPS.

Откройте eclipse-theia.yaml​​ для редактирования:

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

Во-первых, укажите ClusterIssuer letsencrypt-prod, созданный вами согласно предварительным требованиям, в качестве издателя, который будет использоваться для предоставления сертификатов для Ingress. Затем в разделе tls необходимо задать точный домен, который следует защитить, а также имя для секрета, который будет хранить эти сертификаты.

Сохраните и закройте файл.

Примените изменения, внесенные в ваш кластер, с помощью следующей команды:

kubectl apply -f eclipse-theia.yaml

Вывод будет выглядеть следующим образом:

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

Потребуется несколько минут для предоставления и полного применения сертификатов. Вы можете отслеживать прогресс, выполнив следующую команду:

kubectl describe certificate theia-prod -n theia

После завершения ее выполнения, конечная часть вывода будет выглядеть примерно так:

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

Обновите домен в браузере. Вы увидите зеленый замок с левой стороны адресной строки, что означает, что соединение защищено.

Вы настроили Ingress для использования сертификатов Let’s Encrypt, обеспечив дополнительную защиту для развертывания Eclipse Theia. Теперь вы можете просмотреть пользовательский интерфейс Eclipse Theia по умолчанию.

В этом разделе вы изучите некоторые функции интерфейса Eclipse Theia.

С левой стороны интерфейса IDE имеется вертикальный ряд 4 кнопок для доступа к наиболее часто используемым функциям на боковой панели.

Эта панель настраивается, поэтому вы можете перемещать эти представления в различном порядке или удалять их из панели. По умолчанию первое представление открывает панель обозревателя, которая обеспечивает возможность навигации по структуре проекта, имеющей форму дерева. Здесь вы можете управлять папками и файлами — создавать, удалять, перемещать их при необходимости.

После создания нового файла через меню File вы увидите пустой файл, открытый в новой вкладке. После сохранения файла вы можете увидеть имя файла на боковой панели обозревателя. Чтобы создать папку, нажмите правой кнопкой мыши на боковой панели обозревателя и выберите пункт New Folder. Вы можете развернуть папку, нажав на ее имя, а также перетаскивать файлы и папки в верхнюю часть иерархии, чтобы переместить их в новое место.

Две другие опции обеспечивают доступ к функциям поиска и замены. Следующий элемент обеспечивает представление систем управления исходным кодом, которые вы можете использовать, например Git.

Последнее представление — это опция отладки, которая позволяет выполнять все стандартные действия при отладке в панели. Вы можете сохранить конфигрурации отладчика в файле launch.json.

Центральную часть графического интерфейса занимает редактор, который вы можете разделить вкладками для редактирования кода. Вы можете изменить представление редактирования на сетку или расположенные параллельно файлы. Как и все современные IDE, Eclipse Theia поддерживает подсветку синтаксиса для вашего кода.

Вы можете получить доступ к терминалу, введя ``CTRL+SHIFT+``` или нажав пункт Terminal в верхнем меню и выбрав New Terminal. Терминал откроется в нижней панели, а в качестве его рабочей директории будет указано рабочее пространство проекта, которое содержит файлы и папки, отображаемые в боковой панели обозревателя.

Вы изучили базовые элементы интерфейса Eclipse Theia и познакомились с некоторыми самыми популярными функциями.

Теперь у вас есть Eclipse Theia, гибкий облачная IDE, установленная на вашем кластере DigitalOcean Kubernetes. Вы обеспечили безопасность вашей установки с помощью бесплатного TLS-сертификата Let’s Encrypt и настроили запрос учетных данных посетителя при входе. Вы можете работать с исходным кодом и документами индивидуально или вместе с вашей командой. Также вы можете попробовать выполнить сборку вашей собственной версии Eclipse Theia, если вам требуются дополнительные функции. Дополнительную информацию о том, как это можно сделать, см. в документации Theia.