Замена ссылок импортированных из Confluence страниц

Документ описывает инструкцию по замене ссылок на страницы Confluence в описаниях импортированнх задач на ссылки аналогичных страниц в TeamStorm.

Порядок запуска

Перед запуском скрипта убедитесь, что выполнен импорт всех необходимых пространств, ссылки на которые существуют в описаниях импортированнх задач. Все страницы, на которые есть ссылки, должны быть импортированы в TeamStorm перед запуском.

Исходные данные

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

архив со скриптами импорта
URL сервера TeamStorm
токен аутентификации пользователя TeamStorm
URL сервера Confluence
персональный токен доступа пользователя Confluence

Подготовка запуска

Установите среду выполнения Python 3.11.

Установите следующие модули:

    pip install \
        Markdown==3.4.4
        requests==2.31.0
        jira2markdown==0.3.4
        dataclasses-json==0.5.7
        future==0.18.2
        pytz==2023.3
        jsonpickle==3.0.2

Распакуйте архив со скриптами миграции

Получение токена аутентификации TeamStorm

Для аутентификации в API TeamStorm необходимо выбрать учетную запись пользователя, у которого есть системные роли "Администратор Core" и "Пользователь TeamStorm".

Авторизуйтесь в TeamStorm в браузере с выбранной учетной записью.
Откройте веб-инспектор браузера.
Откройте любой запрос TeamStorm.
Скопируйте из заголовка запроса Authorization токен авторизации (символы без "Bearer").

Создание токена Confluence

Авторизуйтесь в Confluence с выбранной учетной записью.
Создайте и сохраните персональный ключ доступа в профиле пользователя согласно документации Atlassian Using Personal Access Tokens

Основные параметры скрипта

- URL сервера TeamStorm
```
"https:\\teamstorm.io"
```
- токен аутентификации пользователя TeamStorm
```
"EzLCJzaWQiOiJh...jzSZHNHP3Jw"
```
- URL сервера Confluence
```
"https:\\confluence.yourdomain.ru"
```
- персональный токен доступа пользователя Confluence
```
"EzLCJzaWQiOiJh...jzSZHNHP3Jw"
```

Дополнительные параметры скрипта

Выбор пространств TeamStorm для поиска страниц

Для оптимизации времени выполнения скрипта можно ограничить поиск страниц в TeamStorm только теми простанствами, для которых существуют ссылки. По умолчанию поиск выполняется по всем пространствам, что может существенно увеличить время импорта. Для поиска страниц только в определенных пространствах можно передать их ключи через параметр --ts_spaces:

    --ts_spaces "KEY1" "KEY2"

Выбор пространств Confluence для поиска страниц

Для оптимизации времени выполнения скрипта можно ограничить поиск страниц в Confluence только теми простанствами, для которых существуют ссылки. По умолчанию поиск выполняется по всем пространствам, что может существенно увеличить время импорта. Для поиска страниц только в определенных пространствах можно передать их названия через параметр --c_spaces:

    --c_spaces "Space 1" "Space 2"

Запуск скрипта

Перейдите в папку со скриптами

Выполните команду c необходимыми параметрами

python3 migrate_conf_urls.py <ts_url> \
                             <ts_bearer> \
                             <с_url> \
                             <с_token> [Дополнительные параметры скрипта]

Пример вызова скрипта:

python3 migrate_conf_urls.py "http://teamstorm.ru"
"EzLCJzaWQiOiJh...jzSZHNHP3Jw"
"http://local-confluence.yourdomain.ru"
"EzLCJzaWQiOiJh...WQiZHNH+f3T"
--ts_spaces "KEY1" "KEY2"
--c_spaces "Space 1" "Space 2"

Дождитесь выполнения скрипта
Проверьте, что ссылки на страницы Confluence, заменены на ссылки аналогичных страниц, импортированных в TeamStorm