One place for hosting & domains

      IDEплатформы

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


      Автор выбрал фонд Free and Open Source Fund для получения пожертвования в рамках программы Write for DOnations.

      Введение

      По мере перемещения инструментов для разработчиков в облако, появляется все большее количество облачных 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 или воспользоваться услугами любого предпочитаемого регистратора доменных имен.

      Шаг 1 — Установка и размещение Eclipse Theia

      Для начала мы установим 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. Создайте файл с помощью следующей команды:

      Добавьте в файл следующие строки:

      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

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

      Шаг 2 — Активация аутентификации при входе для вашего домена

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

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

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

      • sudo apt install apache2-utils -y

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

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

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

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

      Примечание: если в системе, в которой вы работаете, не установлена утилита htpasswd, вы можете использовать версию из Docker.

      Вам потребуется установить Docker на вашем компьютере. Инструкции по установке содержатся в официальной документации.

      Запустите следующую команду для запуска контейнеризованной версии:

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

      Не забудьте заменить <username>​​​ на имя пользователя, которое вы хотите использовать. Вам будет предложено ввести пароль. Хэшированная комбинация данных для входа будет выведена в консоль, и вам потребуется вручную добавить ее в конец файла auth. Повторите этот процесс для необходимого количества логинов, которое вы хотите добавить.

      После выполнения этих действий создайте новый секрет в 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, чтобы он смог использовать секрет. Откройте конфигурацию развертывания для редактирования:

      Добавьте в файл следующие выделенные строки:

      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 передавался в зашифрованному виде.

      Шаг 3 — Применение HTTPS сертификатов Let’s Encrypt

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

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

      Добавьте выделенные строки в файл и обязательно замените используемый в качестве примера домен на собственный:

      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 по умолчанию.

      Шаг 4 — Использование интерфейса Eclipse Theia

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

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

      Графический интерфейс Eclipse Theia — боковая панель

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

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

      Графический интерфейс Eclipse Theia — новая папка

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

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

      Представление отладчика с открытым файлом launch.json

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

      Вид редактора в сетку

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

      Открытый терминал

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

      Заключение

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



      Source link

      Настройка облачной IDE-платформы Eclipse Theia на Ubuntu 18.04 [Краткое руководство]


      Введение

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

      В этом обучающем руководстве мы выполним развертывание Eclipse Theia на сервере Ubuntu 18.04 с помощью Docker Compose. Мы подключим среду к домену с помощью nginx-proxy и защитим ее TLS-сертификатом Let’s Encrypt, выделяемым с помощью дополнительной надстройки. Более подробное описание можно найти в обучающем руководстве Настройка облачной IDE-платформы Eclipse Theia в Ubuntu 18.04.

      Предварительные требования

      • Сервер Ubuntu 18.04 с привилегиями root и дополнительной учетной записью без привилегий root, настроенный в соответствии с указаниями руководства Начальная настройка сервера Ubuntu 18.04.
      • Установленная на сервере система Docker в соответствии с шагом 1 и шагом 2 руководства Установка Docker в Ubuntu 18.04.
      • Установленная на сервере служба Docker Compose в соответствии с шагом 1 руководства Установка Docker Compose в Ubuntu 18.04.
      • Зарегистрированное полное доменное имя. В этом обучающем руководстве мы будем использовать доменное имя theia.your-domain.
      • Запись DNS A с theia.your-domain, указывающим на публичный IP-адрес вашего сервера. В руководстве Введение в DigitalOcean DNS содержится подробная информация по их добавлению.

      Шаг 1 — Развертывание nginx-proxy с Let’s Encrypt

      Создайте директорию для хранения всех данных Eclipse Theia:

      Перейдите в директорию:

      Создайте файл nginx-proxy-compose.yaml для сохранения конфигурации Docker Compose для nginx-proxy:

      • nano nginx-proxy-compose.yaml

      Добавьте следующие строки:

      ~/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"
      

      Здесь мы определяем две службы, которые будет выполнять Docker Compose, nginx-proxy и его спутник Let’s Encrypt. Для прокси вы должны задать в качестве образа jwilder/nginx-proxy, разметить порты HTTP и HTTPS, а также определить тома, которые будут доступны во время исполнения.

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

      Разверните конфигурацию:

      • docker-compose -f nginx-proxy-compose.yaml up -d

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

      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

      Шаг 2 — Развертывание контейнеризованной среды Eclipse Theia

      nginx-proxy ожидает, что комбинации для входа будут находиться в файле с именем подключенного домена, который имеет формат htpasswd и хранится в директории /etc/nginx/htpasswd в контейнере.

      Выполните установку htpasswd:

      • sudo apt install apache2-utils

      Пакет apache2-utils содержит утилиту htpasswd.

      Создайте директорию /etc/nginx/htpasswd:

      • sudo mkdir -p /etc/nginx/htpasswd

      Создайте файл для сохранения учетных данных вашего домена:

      • sudo touch /etc/nginx/htpasswd/theia.your-domain

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

      • sudo htpasswd /etc/nginx/htpasswd/theia.your-domain username

      htpasswd добавит имя пользователя и пароль в конец файла.

      Создайте конфигурацию для развертывания Eclipse Theia:

      • nano eclipse-theia-compose.yaml

      Добавьте следующие строки:

      ~/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
      

      Вы определяете одну службу с именем eclipse-theia, задаете для параметра restart значение always и определяете theiaide/theia:next как образ контейнера. Также вы задаете для init значение true. Затем нужно задать две переменные среды в разделе environment: VIRTUAL_HOST и LETSENCRYPT_HOST.

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

      Теперь выполните развертывание Eclipse Theia с помощью следующей команды:

      • docker-compose -f eclipse-theia-compose.yaml up -d

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

      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

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

      Графический интерфейс Eclipse Theia

      Заключение

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



      Source link

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


      Автор выбрал фонд Free and Open Source Fund для получения пожертвования в рамках программы Write for DOnations.

      Введение

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

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

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

      Предварительные требования

      • Сервер Debian 10 с привилегиями root, а также дополнительной учетной записью без привилегий root. Инструкции по настройке приведены в руководстве Начальная настройка сервера Debian 10. Для целей этого обучающего руководства используется дополнительная учетная запись sammy без привилегий root.
      • Docker, установленный на сервере. Выполните шаг 1 и шаг 2 руководства Установка Docker на Debian 10. Более подробную информацию о Docker см. в статье Экосистема Docker: знакомство с общими компонентами.
      • Docker Compose, установленный на сервере. Следуйте указаниям, приведенным в шаге 1 руководства Установка Docker Compose в Debian 10.
      • Зарегистрированное полное доменное имя. В этом обучающем руководстве мы будем использовать имя theia.your_domain. Вы можете купить доменное имя на Namecheap, получить его бесплатно на Freenom или воспользоваться услугами любого предпочитаемого регистратора доменных имен.
      • Запись A, где theia.your_domain​​​ указывает на публичный IP-адрес вашего сервера. В руководстве Введение в DigitalOcean DNS содержится подробная информация по их добавлению.

      Шаг 1 — Развертывание nginx-proxy с Let’s Encrypt

      В этом разделе мы развернем nginx-proxy и его дополнительный модуль Let’s Encrypt с помощью Docker Compose. Это позволит автоматически предоставлять и обновлять TLS-сертификат, чтобы при развертывании Eclipse Theia была доступна на вашем домене через HTTPS.

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

      Перейдите в директорию:

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

      • nano nginx-proxy-compose.yaml

      Добавьте следующие строки:

      ~/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"
      

      Здесь мы определяем две службы, которые будет выполнять Docker Compose, nginx-proxy и его спутник Let’s Encrypt. Для прокси вы должны задать в качестве образа jwilder/nginx-proxy, разметить порты HTTP и HTTPS, а также определить тома, которые будут доступны во время исполнения.

      Тома — это директории на сервере, к которым будет иметь полный доступ определенная служба, которую вы будете использовать позднее для настройки аутентификации пользователя. Чтобы сделать это, мы используем первый том из списка, который сопоставляет локальную директорию /etc/nginx/htpasswd с такой же директорией в контейнере. В этой папке nginx-proxy ожидает найти файл с именем, повторяющим имя целевого домена, который будет содержать учетные данные для входа и организации аутентификации пользователей в формате htpasswd (username:hashed_password).

      Для дополнительного модуля вы присваиваете имя образа Docker и предоставляете доступ к сокету Docker, указав том. Затем вы должны указать, что дополнительный модуль должен наследовать доступ к томам, определенным для nginx-proxy. Для обеих служб установлено значение always для restart, которое указывает Docker выполнять перезапуск контейнера в случае перезагрузки или сбоя системы.

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

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

      • docker-compose -f nginx-proxy-compose.yaml up -d

      Здесь вы передаете имя файла nginx-proxy-compose.yaml с параметром -f для команды docker-compose, которая указывает файл для запуска. Затем вы передаете up, чтобы запустить контейнеры. Флаг -d активирует раздельный режим, в результате чего Docker Compose будет запускать контейнеры в фоновом режиме.

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

      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

      Вы развернули nginx-proxy и его дополнение Let’s Encrypt с помощью Docker Compose. Теперь вы можете перейти к настройке Eclipse Theia на вашем домене и обеспечению безопасности.

      Шаг 2 — Развертывание контейнеризованной среды Eclipse Theia

      В этом разделе вы создадите файл, содержащий любые разрешенные варианты комбинаций, используемых для входа в систему, которые должен будет вводить пользователь. Затем вы развернете Eclipse Theia на вашем сервере с помощью Docker Compose и опубликуете его на защищенном домене с помощью nginx-proxy.

      Как было сказано в предыдущем шаге, nginx-proxy ожидает увидеть комбинации для входа в файле с именем, соответствующим выделенному домену, в формате htpasswd, который хранится в директории /etc/nginx/htpasswd в контейнере. Локальная директория, которая сопоставлена с виртуальной, не должна быть ее копией, как мы указали в конфигурации nginx-proxy.

      Чтобы создать комбинации входа, вам нужно установить htpasswd, запустив следующую команду:

      • sudo apt install apache2-utils

      Пакет apache2-utils содержит утилиту htpasswd.

      Создайте директорию /etc/nginx/htpasswd:

      • sudo mkdir -p /etc/nginx/htpasswd

      Создайте файл, который будет хранить логины для вашего домена:

      • sudo touch /etc/nginx/htpasswd/theia.your_domain

      Обязательно замените theia.your_domain на ваш собственный домен Eclipse Theia.

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

      • sudo htpasswd /etc/nginx/htpasswd/theia.your_domain username

      Замените username на имя пользователя, которое вы хотите добавить. Вам нужно будет дважды ввести пароль. После предоставления нужных данных htpasswd добавит пару (имя пользователя и хэшированный пароль) в конец файла. Вы можете повторить эту команду, добавив необходимое количество логинов.

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

      • nano eclipse-theia-compose.yaml

      Добавьте следующие строки:

      ~/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
      

      В этой конфигурации мы определяем одну службу с именем eclipse-theia со значением always для параметра restart и theiaide/theia:next​​​ в качестве образа контейнера. Также вы должны задать для init значение true, чтобы указать Docker использовать в качестве главного диспетчера процессов init при запуске Eclipse Theia в контейнере.

      Затем нужно задать две переменные среды в разделе environment: VIRTUAL_HOST и LETSENCRYPT_HOST. Первый элемент передается в nginx-proxy и указывает, на каком домене должен быть опубликован контейнер, а второй элемент используется в дополнении Let’s Encrypt и указывает, для какого домена нужно запрашивать TLS-сертификаты. Если вы не указали в качестве значения для VIRTUAL_HOST подстановочный знак, они должны быть одинаковыми.

      Замените theia.your_domain на желаемый домен, а затем сохраните и закройте файл.

      Теперь выполните развертывание Eclipse Theia с помощью следующей команды:

      • docker-compose -f eclipse-theia-compose.yaml up -d

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

      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

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

      Графический интерфейс Eclipse Theia

      Теперь, когда у вас есть безопасный доступ к облачной IDE, вы можете начать использовать редактор на следующем шаге.

      Шаг 3 — Использование интерфейса Eclipse Theia

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

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

      Графический интерфейс Eclipse Theia — боковая панель

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

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

      Графический интерфейс Eclipse Theia — новая папка

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

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

      Представление отладчика с открытым файлом launch.json

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

      Вид редактора в сетку

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

      Открытый терминал

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

      Заключение

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



      Source link