Help:XSvacer:Webide:SvacerAsDockerContainer - Revision history

Akuzmin: add note about 12-0-0 version

2025-11-20T11:21:38Z

add note about 12-0-0 version

← Older revision		Revision as of 14:21, 20 November 2025
Line 1:		Line 1:
			{{Note\|type=reminder\|text=Начиная с версии 12-0-0 WebIDE уже настроена в предоставляемом нами докер-образе и [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose файле]}}

	= Поддержка функциональности [[Help:XSvacer:Webide\|webide]], когда Svacer развёрнут в docker-контейнере =		= Поддержка функциональности [[Help:XSvacer:Webide\|webide]], когда Svacer развёрнут в docker-контейнере =

Akuzmin: /* Решение */ (remove memsettings)

2025-10-30T10:10:44Z

Решение: (remove memsettings)

← Older revision		Revision as of 13:10, 30 October 2025
Line 81:		Line 81:

	<pre>		<pre>
	CMD /svacer/bin/svacer-server ~~--memsettings=${MEMSETTINGS}~~ run --store $STORE --pg $SVACER_PG_URL		CMD /svacer/bin/svacer-server run --store $STORE --pg $SVACER_PG_URL
	</pre>		</pre>

Line 91:		Line 91:
	svacer:		svacer:
	...		...
	command: /bin/sh -c '/svacer/bin/svacer-server ~~--memsettings=$${MEMSETTINGS}~~ run --store $$STORE --pg $${SVACER_PG_URL} --xsvacer.features webide'		command: /bin/sh -c '/svacer/bin/svacer-server run --store $$STORE --pg $${SVACER_PG_URL} --xsvacer.features webide'
	</pre>		</pre>

Akuzmin: minor style fixes

2025-05-13T12:35:03Z

minor style fixes

Show changes

M.vinogradov at 09:41, 12 March 2025

2025-03-12T09:41:32Z

← Older revision		Revision as of 12:41, 12 March 2025
Line 41:		Line 41:
	# Перезапустить контейнер Svacer;		# Перезапустить контейнер Svacer;

	Чтобы примонтировать <code>svacer.cfg</code> к контейнеру Svacer нужно в файл <code>docker-compose.~~yaml~~</code> добавить строку:		Чтобы примонтировать <code>svacer.cfg</code> к контейнеру Svacer нужно в файл <code>docker-compose.yml</code> добавить строку:

	<pre style="font: 1em Courier New, monospace;">		<pre style="font: 1em Courier New, monospace;">
Line 174:		Line 174:
	</pre>		</pre>

	<code>docker-compose.~~yaml~~</code>:		<code>docker-compose.yml</code>:

	<pre style="font: 1em Courier New, monospace;">		<pre style="font: 1em Courier New, monospace;">
Line 246:		Line 246:

	<div class="toccolours mw-collapsible mw-collapsed">		<div class="toccolours mw-collapsible mw-collapsed">
	<div style="font-weight:bold;line-height:1.6;"><code>docker-compose.~~yaml~~</code></div>		<div style="font-weight:bold;line-height:1.6;"><code>docker-compose.yml</code></div>
	<div class="mw-collapsible-content">		<div class="mw-collapsible-content">
	{{Note\|type=info\|text=Изменены внесены в файл [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose.yml]}}		{{Note\|type=info\|text=Изменены внесены в файл [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose.yml]}}

M.vinogradov at 11:10, 11 March 2025

2025-03-11T11:10:08Z

Show changes

M.vinogradov at 08:24, 11 March 2025

2025-03-11T08:24:08Z

← Older revision		Revision as of 11:24, 11 March 2025
Line 170:		Line 170:
	...		...
	</pre>		</pre>

			== Схемы компонентов ==

			Ниже приведены концептуальные схемы компонентов, на базе которых основана функциональность запуска IDE. Данные схемы могут быть использованы для поиска других решений приведённых выше задач.

			=== Стандартный запуск Svacer в виде сервиса ===

			[[File:Comp-svacer-webide-default-hosting.png]]

			=== Запуск Svacer внутри docker-контейнера ===

			[[File:Comp-svacer-in-container-webide-hosting.png]]

M.vinogradov at 07:16, 11 March 2025

2025-03-11T07:16:53Z

← Older revision		Revision as of 10:16, 11 March 2025
Line 40:		Line 40:
	== Предоставление контейнеру Svacer доступа к управлению контейнерами IDE ==		== Предоставление контейнеру Svacer доступа к управлению контейнерами IDE ==

	Функциональность запуска IDE основана на том, что Svacer управляет контейнерами IDE с помощью API docker~~-хоста~~. Поэтому необходимо предоставить доступ к API docker~~-хоста~~ из docker-контейнера Svacer.		Функциональность запуска IDE основана на том, что Svacer управляет контейнерами IDE с помощью API docker'а. Поэтому необходимо предоставить доступ к API docker'а из docker-контейнера Svacer.

	=== Решение ===		=== Решение ===

	Один из способов подключения к API docker~~-хоста~~ является использование socket-файла <code>/var/run/docker.sock</code>. Чтобы Svacer получил доступ к этому файлу, его необходимо примонтировать к docker-контейнеру:		Один из способов подключения к API docker'а является использование socket-файла <code>/var/run/docker.sock</code>. Чтобы Svacer получил доступ к этому файлу, его необходимо примонтировать к docker-контейнеру:

	<pre style="font: 1em Courier New, monospace;">		<pre style="font: 1em Courier New, monospace;">

M.vinogradov: Created page with "= Поддержка функциональности [https://svacer.ispras.ru/mediawiki/index.php?title=Help:XSvacer:Webide webide] когда Svacer развёрнут в docker-контейнере = На данный момент функциональность запуска Theia IDE по умолчанию настроена на запуск Svacer с помощью исполняемого файла, "рядом" с docker'ом. Для поддержки ф..."

2025-03-10T08:06:35Z

Created page with "= Поддержка функциональности [https://svacer.ispras.ru/mediawiki/index.php?title=Help:XSvacer:Webide webide] когда Svacer развёрнут в docker-контейнере = На данный момент функциональность запуска Theia IDE по умолчанию настроена на запуск Svacer с помощью исполняемого файла, "рядом" с docker'ом. Для поддержки ф..."

New page

= Поддержка функциональности [https://svacer.ispras.ru/mediawiki/index.php?title=Help:XSvacer:Webide webide] когда Svacer развёрнут в docker-контейнере =

На данный момент функциональность запуска Theia IDE по умолчанию настроена на запуск Svacer с помощью исполняемого файла, "рядом" с docker'ом.

Для поддержки функциональности <code>webide</code> когда Svacer развёрнут в docker-контейнере необходимо решить следующие задачи:

# Активация функциональности <code style="white-space: pre;">webide</code> в docker-контейнере Svacer;
# Предоставить docker-контейнеру Svacer доступ к управлению контейнерами IDE;
# Организация сетевого доступа между контейнером Svacer и контейнерами IDE;
# Настройка доступа к общему хранилищу с исходными файлами для контейнера Svacer и контейнеров IDE;

Детали каждой задачи и варианты решения приведены ниже.

{{Note|type=info|text=Приведённые решения основаны на развёртывании Svacer с помощью файла [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose.yml]}}

== Активация функциональности <code>webide</code> ==

Для активации функциональности <code>webide</code> необходимо при запуске Svacer указать флаг <code>--xsvacer.features webide</code>

=== Решение ===

В [https://svacer.ispras.ru/extra/docker-compose.yml docker-compose.yml] используется docker-образ Svacer, собранный на основе [[Dockerfile]]. В данном файле содержится инструкция запуска Svacer

<pre style="font: 1em Courier New, monospace;">
CMD /svacer/bin/svacer-server --memsettings=${MEMSETTINGS} run --store $STORE --pg $SVACER_PG_URL
</pre>

Для активации функциональности IDE необходимо переопределить аргументы инструкции <code style="white-space: pre;">CMD</code> в файле <code>docker-compose.yml</code>:

<pre style="font: 1em Courier New, monospace;">
services:
...
svacer:
...
command: /bin/sh -c '/svacer/bin/svacer-server --memsettings=$${MEMSETTINGS} run --store $$STORE --pg $${SVACER_PG_URL} --xsvacer.features webide'
</pre>

{{Note|type=info|text=Проверить актуальные значения аргументов инструкции <code>CMD</code> docker-образа можно с помощью команды <code>docker image inspect {имя образа}</code>}}

== Предоставление контейнеру Svacer доступа к управлению контейнерами IDE ==

Функциональность запуска IDE основана на том, что Svacer управляет контейнерами IDE с помощью API docker-хоста. Поэтому необходимо предоставить доступ к API docker-хоста из docker-контейнера Svacer.

=== Решение ===

Один из способов подключения к API docker-хоста является использование socket-файла <code>/var/run/docker.sock</code>. Чтобы Svacer получил доступ к этому файлу, его необходимо примонтировать к docker-контейнеру:

<pre style="font: 1em Courier New, monospace;">
services:
...
svacer:
...
volumes:
...
- /var/run/docker.sock:/var/run/docker.sock:ro
...
</pre>

== Изменение настроек Svacer - <code>svacer.cfg</code> ==

Дальнейшие шаги связаны с изменением настроек Svacer. В случае, когда Svacer развёрнут в docker-контейнере, это можно сделать следующим образом:
# Создать конфигурационный файл <code>svacer.cfg</code>;
# Примонтировать файл к рабочей директории docker-контейнера Svacer;
# Перезапустить контейнер Svacer;

Чтобы примонтировать <code>svacer.cfg</code> к контейнеру Svacer нужно в файл <code>docker-compose.yaml</code> добавить строку:

<pre style="font: 1em Courier New, monospace;">
services:
...
svacer:
...
volumes:
...
- /path/to/svacer.cfg:/svacer/bin/svacer.cfg:ro
...
</pre>

=== Перенос настроек функциональности <code>webide</code> в <code>svacer.cfg</code> ===

Скопировать секцию с [https://svacer.ispras.ru/mediawiki/index.php?title=Help:XSvacer:Webide#.D0.9A.D0.BE.D0.BD.D1.84.D0.B8.D0.B3.D1.83.D1.80.D0.B0.D1.86.D0.B8.D1.8F_.D0.BF.D0.BE_.D1.83.D0.BC.D0.BE.D0.BB.D1.87.D0.B0.D0.BD.D0.B8.D1.8E настройками по умолчанию] в <code>svacer.cfg</code>

== Организация сетевого доступа между контейнером Svacer и контейнерами IDE ==

В текущей реализации при запуске docker-контейнер IDE публикует внутренний порт web-приложения Theia IDE на случайный порт всех сетевых интерфейсов (0.0.0.0) docker-хоста. Svacer хранит информацию на каком порте хоста развёрнуты соответствующие инстансы IDE и проксирует запросы к ним.

Необходимо организовать доступ контейнера Svacer к портам docker-хоста, на которых опубликованы контейнеры IDE.

=== Решение ===

Чтобы предоставить доступ контейнера Svacer к контейнеру IDE нужно:
# Определить ip-адрес интерфейса docker-хоста <code>docker0</code>;
# Изменить настройку публикации портов контейнеров IDE на значение ip-адреса <code>docker0</code>.

''' Определение ip-адреса <code>docker0</code>'''

На docker-хосте выполнить команду <code>ip a</code>:

<pre style="font: 1em Courier New, monospace;">
$ ip a
...
6: docker0: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue state DOWN group default
link/ether 82:70:b5:24:50:e4 brd ff:ff:ff:ff:ff:ff
inet 172.17.0.1/16 brd 172.17.255.255 scope global docker0
valid_lft forever preferred_lft forever
</pre>

В данном случае искомый ip-адрес - <code>172.17.0.1</code>

''' Изменение настроек публикации портов контейнеров IDE '''

Настройки публикации порта контейнера IDE заданы в [https://svacer.ispras.ru/mediawiki/index.php?title=Help:XSvacer:Webide#.D0.9A.D0.BE.D0.BD.D1.84.D0.B8.D0.B3.D1.83.D1.80.D0.B0.D1.86.D0.B8.D1.8F_.D0.B7.D0.B0.D0.BF.D1.83.D1.81.D0.BA.D0.B0_Theia_IDE конфигурации запуска IDE]. Настройки по умолчанию должны быть предварительно [https://svacer.ispras.ru/mediawiki/index.php?title=Help:XSvacer:Webide:SvacerAsDockerContainer&action=submit#.D0.9F.D0.B5.D1.80.D0.B5.D0.BD.D0.BE.D1.81_.D0.BD.D0.B0.D1.81.D1.82.D1.80.D0.BE.D0.B5.D0.BA_.D1.84.D1.83.D0.BD.D0.BA.D1.86.D0.B8.D0.BE.D0.BD.D0.B0.D0.BB.D1.8C.D0.BD.D0.BE.D1.81.D1.82.D0.B8_webide_.D0.B2_svacer.cfg перенесены в <code>svacer.cfg</code>].

В файле <code>svacer.cfg</code> нужно добавить параметр <code>hostip</code> со значением ip-адреса интерфейса <code>docker0</code>:

<pre style="font: 1em Courier New, monospace;">
xsvacer:
webide:
theia:
1-46-0: &1-46-0
...
docker:
...
container:
...
hostconfig:
...
portbindings:
"3000/tcp":
- hostport: 0
hostip: 172.17.0.1 # новый параметр
...
</pre>

== Настройка доступа к общему хранилищу с исходными файлами для контейнера Svacer и контейнеров IDE ==

При запуске IDE для просмотра снимка, Svacer экспортирует исходный код снимка в папку на docker-хосте. Далее эта папка монтируется к контейнеру IDE, к пути <code>/home/project</code>, который использует Theia IDE в качестве папки проекта.

При развёртывании Svacer в docker-контейнере необходимо настроить экспорт исходников в папку, которая может быть примонтирована к контейнеру IDE.

=== Решение ===

Путь к корневой папке, в которую будут экспортироваться исходники снимков, задаётся в конфигурационном параметре [https://svacer.ispras.ru/mediawiki/index.php?title=Help:XSvacer:Webide#.D0.91.D0.B0.D0.B7.D0.BE.D0.B2.D1.8B.D0.B5_.D0.BF.D0.B0.D1.80.D0.B0.D0.BC.D0.B5.D1.82.D1.80.D1.8B_.D0.BA.D0.BE.D0.BD.D1.84.D0.B8.D0.B3.D1.83.D1.80.D0.B0.D1.86.D0.B8.D0.B8_.D0.B7.D0.B0.D0.BF.D1.83.D1.81.D0.BA.D0.B0 <code>sourcesroot</code>]. Так как этот же параметр используется для настройки пути к корневой папке на docker-хосте, которая будет примонтирована к контейнеру IDE, то пути к папке с исходным кодом снимков должны совпадать в контейнере Svacer и на docker-хосте.

''' Пример конфигурации '''

<code>svacer.cfg</code>:

<pre style="font: 1em Courier New, monospace;">
xsvacer:
webide:
theia:
1-46-0: &1-46-0
...
sourcesroot: /data/snapshot-sources
...
</pre>

<code>docker-compose.yaml</code>:

<pre style="font: 1em Courier New, monospace;">
services:
...
svacer:
...
volumes:
...
- /data/snapshot-sources:/data/snapshot-sources
...
</pre>