Оновлення MongoDB

Кожен новий випуск Server CE/Server Pro зазначає будь-які зміни підтримуваної версії MongoDB у своїх примітках до випуску.

​

Чи потрібно оновлювати MongoDB?

Оновлення версії MongoDB варто розглядати лише тоді, коли ви плануєте оновити свій екземпляр Server CE/Server Pro.

Якщо ваша версія MongoDB новіша за рекомендовану для поточної (або цільової) версії, жодних змін вносити не потрібно.

Ніколи не знижуйте версію MongoDB.

Якщо у вас виникла конкретна проблема, яка, на вашу думку, може бути пов’язана з поточною версією MongoDB, ви можете створити issue, якщо ви користувач Server CE, або звернутися до служби підтримки Overleaf, якщо ви користувач Server Pro.

​

Перевірка версії MongoDB

Відкриття оболонки mongo має одразу вивести поточну версію.

Користувачі Overleaf Toolkit:

bin/docker-compose exec mongo mongod --version
db version v5.0.24
Build Info: {
    "version": "5.0.24",
    "gitVersion": "f034f0c51b3dffef4b8c9452d77ede9888f28f66",
    "openSSLVersion": "OpenSSL 1.1.1f  31 Mar 2020",
    "modules": [],
    "allocator": "tcmalloc",
    "environment": {
        "distmod": "ubuntu2004",
        "distarch": "x86_64",
        "target_arch": "x86_64"
    }
}

Користувачі Docker Compose:

docker compose exec mongo mongod --version
db version v5.0.24
Build Info: {
    "version": "5.0.24",
    "gitVersion": "f034f0c51b3dffef4b8c9452d77ede9888f28f66",
    "openSSLVersion": "OpenSSL 1.1.1f  31 Mar 2020",
    "modules": [],
    "allocator": "tcmalloc",
    "environment": {
        "distmod": "ubuntu2004",
        "distarch": "x86_64",
        "target_arch": "x86_64"
    }
}

​

Процес оновлення

Оновлення версії MongoDB під час оновлення вашого екземпляра Server CE/Server Pro відбувається так:

1. Визначте версію Server CE/Server Pro, до якої плануєте оновитися.
2. Знайдіть версію MongoDB, рекомендовану для цього конкретного випуску Overleaf Server CE/Server Pro.
3. Виконайте інструкції з оновлення MongoDB до цільової версії.
4. Оновіть версію образу Server CE/Server Pro і перезапустіть екземпляр.

Ми рекомендуємо завжди оновлювати Server CE/Server Pro до останньої доступної версії, оскільки її підтримка завжди гарантована (лише для користувачів Server Pro).

Під час оновлення Server CE/Pro ми рекомендуємо оновитися до останнього випуску розгорнутої мажорної версії, перш ніж оновлюватися до останнього випуску наступної мажорної версії. Якщо ваше розгортання відстає від останньої версії більш ніж на одну мажорну версію, вам доведеться виконати багатоетапне оновлення.

Наприклад, якщо у вас 3.5.10, потрібно оновитися до 3.5.13 -> виконати міграцію Full Project History -> 4.2.9 -> 5.5.4.

Ніколи не пропускайте мажорні версії (3.5.10 -> 5.5.4). Якщо ви використовуєте Toolkit і відстаєте від останньої версії більш ніж на одну мажорну версію, не використовуйте скрипт bin/upgrade, оскільки вам потрібно буде виконати ручне багатоетапне оновлення.

Важливо створювати узгоджену резервну копію перед кожним оновленням мажорної версії, щоб за потреби мати змогу відкотитися.

​

Інформація про підтримку версій

Якщо ви вирішите перейти на попередню версію, у цій таблиці наведено рекомендовану версію MongoDB для попередніх випусків Server CE/Server Pro, однак ніколи не знижуйте версію MongoDB.

Server CE/Server Pro	Версія MongoDB	Мінімальна версія сумісності функцій	Максимальна версія, яку підтримує драйвер Node.js
2.0.x	3.4	-	-
від 2.1.x до 2.4.x	3.6	-	-
>=2.5.0	4.0	-	-
>=3.1.0	4.2	-	-
>=3.2.0	4.4	-	-
>=4.2.0	5.0	-	-
>=5.1.0	6.0	-	-
>=5.3.1	6.0	5.0	8.0
>=5.5.0	6.0	6.0	8.0
6.0.0	8.0	8.0	8.0

Наведена вище мінімальна версія сумісності функцій ґрунтується на відповідній версії MongoDB, рекомендованій для використання з наведеною версією Overleaf. Якщо ви плануєте використовувати вищу версію, MongoDB матиме власні мінімальні вимоги.

Таблицю сумісності з підтримуваними версіями драйвера MongoDB Node.js для використання з MongoDB можна переглянути тут.

Статус завершення підтримки (end-of-life) для кожної версії MongoDB можна переглянути тут.

​

Оновлення MongoDB

MongoDB вимагає покрокового оновлення. Це означає, що не можна перейти, скажімо, з 4.0 одразу на 5.0. Спочатку потрібно оновитися з 4.2 до 4.4, а потім до 5.0.

MongoDB використовує парні номери для своїх стабільних версій.

​

Інструкції з оновлення, якщо MongoDB працює поза Docker

Нижче наведено посилання на інструкції з оновлення MongoDB на mongodb.com.

• Примітки до випуску MongoDB — оновлення MongoDB з 4.2 до 4.4
• Примітки до випуску MongoDB — оновлення MongoDB з 4.4 до 5.0
• Примітки до випуску MongoDB — оновлення MongoDB з 5.0 до 6.0
• Примітки до випуску MongoDB — оновлення MongoDB з 6.0 до 7.0
• Примітки до випуску MongoDB — оновлення MongoDB з 7.0 до 8.0

Інструкції для 5.0 і вище стосуються встановлення у вигляді набору реплік (replica set), а не автономного (standalone). Оскільки Server Pro/CE 4.0.1+ використовує транзакції, MongoDB має працювати як набір реплік.

Документація для MongoDB від 3.2 до 4.2 тепер доступна за адресою https://www.mongodb.com/docs/legacy/

Базові інструкції

У більшості випадків оновлення вимагає встановлення прапорця сумісності перед фактичним оновленням версії mongo. Кроки такі:

1. Встановіть прапорець сумісності, як описано в примітках до випуску MongoDB (див. приклади нижче).
2. Потім оновіть образ mongo:
   1. Користувачі Toolkit — оновіть MONGO_VERSION, наприклад MONGO_VERSION=6.0
   2. Користувачі Docker Compose — оновіть версію в тегу образу mongo,
      наприклад services -> mongo -> image: mongo:6.0;

Приклад: оновлення MongoDB з 5.0 до 6.0

Почнімо з того, що переконаємося, що використовується MongoDB 6.0:

Користувачі Overleaf Toolkit:

bin/docker-compose exec mongo mongod --version
# db version v5.0.24

Користувачі Docker Compose:

docker compose exec mongo mongod --version
# db version v5.0.24

Згідно з інструкціями з оновлення, єдина вимога — щоб featureCompatibilityVersion мав значення 5.0. Для цього відкриваємо оболонку MongoDB і виконуємо вказану команду:

Користувачі Overleaf Toolkit:

bin/mongo
# MongoDB shell version v5.0.24
# ...
# overleaf:PRIMARY> db.adminCommand( { setFeatureCompatibilityVersion: "5.0" } )
# { 
# "ok" : 1,
# ...
# }
overleaf:PRIMARY> exit
# bye

Користувачі Docker Compose можуть виконати docker compose exec mongo mongosh, щоб отримати оболонку, і виконати ті самі команди, що й користувачі Toolkit.

Користувачі Overleaf Toolkit:

Потім зупиняємо екземпляри Server CE/Server Pro і MongoDB командою bin/stop, встановлюємо MONGO_VERSION=6.0 у config/overleaf.rc, а потім перезапускаємо сервіс mongo за допомогою bin/up mongo), щоб перевірити, що оновлення пройшло без проблем.

Насамкінець оновлюємо версію образу Server CE/Server Pro до цільової версії та повторно створюємо всі сервіси командою bin/up -d.

Користувачі Docker Compose:

Потім зупиняємо екземпляри Server CE/Server Pro і MongoDB командою docker compose stop, змінюємо файл docker-compose.yml, щоб використовувати image: mongo:6.0, а потім перезапускаємо сервіс mongo командою docker compose up mongo, щоб перевірити, що оновлення пройшло без проблем.

Насамкінець оновлюємо версію образу Server CE/Server Pro до цільової версії та повторно створюємо всі сервіси командою docker compose up.

Почніть із того, що переконайтеся, що використовується MongoDB 6.0, за допомогою наведених вище команд mongod --version.

Згідно з інструкціями з оновлення, єдина вимога — щоб featureCompatibilityVersion мав значення 6.0. Для цього відкриваємо оболонку MongoDB і виконуємо команду db.adminCommand({ setFeatureCompatibilityVersion: "6.0" }) .

Користувачі Overleaf Toolkit:

bin/mongo
# ...
# overleaf:PRIMARY> db.adminCommand( { setFeatureCompatibilityVersion: "6.0" } )
# { 
# "ok" : 1,
# ...
# }
overleaf:PRIMARY> exit
# bye

Потім зупиняємо екземпляри Server CE/Server Pro і MongoDB командою bin/stop, встановлюємо MONGO_VERSION=7.0 у config/overleaf.rc, а потім перезапускаємо сервіс mongo за допомогою bin/up mongo), щоб перевірити, що оновлення пройшло без проблем.

Насамкінець оновлюємо версію образу Server CE/Server Pro до цільової версії та повторно створюємо всі сервіси командою bin/up -d.

Почніть із того, що переконайтеся, що використовується MongoDB 7.0, за допомогою наведених вище команд mongod --version.

Згідно з інструкціями з оновлення, єдина вимога — щоб featureCompatibilityVersion мав значення 7.0. Для цього відкриваємо оболонку MongoDB і виконуємо команду db.adminCommand({ setFeatureCompatibilityVersion: "7.0", confirm: true }). Зверніть увагу, що тепер для цього потрібен додатковий параметр confirm: true.

bin/mongo
# ...
# overleaf:PRIMARY> db.adminCommand( { setFeatureCompatibilityVersion: "7.0", confirm: true } )
# { 
# "ok" : 1,
# ...
# }
overleaf:PRIMARY> exit
# bye

Потім зупиняємо екземпляри Server CE/Server Pro і MongoDB командою bin/stop, встановлюємо MONGO_VERSION=8.0 у config/overleaf.rc, а потім перезапускаємо сервіс mongo за допомогою bin/up mongo), щоб перевірити, що оновлення пройшло без проблем.

Насамкінець оновлюємо версію образу Server CE/Server Pro до цільової версії та повторно створюємо всі сервіси командою bin/up -d.

​

Еквівалентні команди для користувачів docker compose

Для користувачів docker compose еквівалентні команди такі:

• docker compose exec mongo mongod --version — щоб показати версію mongo
• docker compose exec mongo mongosh — щоб запустити оболонку mongo для адміністративних команд
• команда docker compose stop — щоб зупинити сервер
• Відредагуйте файл docker-compose.yml, щоб використовувати image: mongo:6.0 для оновлення версії mongo
• docker compose up mongo — щоб перезапустити сервіс mongo і перевірити, що оновлення пройшло без проблем
• Відредагуйте файл docker-compose.yml, щоб використовувати image: sharelatex:VERSION для оновлення версії образу
• docker compose up — щоб повторно створити всі сервіси.

​

Створення власної ролі

У версії 5.5.1 ми додали перевірку під час запуску, яка перевіряє версію сумісності функцій MongoDB. Якщо ваша база даних MongoDB використовує автентифікацію (наприклад, базову автентифікацію), контейнер sharelatex може не запуститися й показати помилку прав доступу “not authorized on admin to execute command”.

Щоб вирішити цю проблему, можна або створити в MongoDB нову роль і призначити її обліковому запису користувача, який використовується для доступу до бази даних, за наведеними нижче інструкціями, або встановити ALLOW_MONGO_ADMIN_CHECK_FAILURES=true, щоб дозволити перевірці завершуватися невдачею, не перешкоджаючи запуску розгортання.

Ця нова роль надає дозвіл лише на читання параметрів сервера MongoDB на рівні кластера, і її можна повторно використовувати для цілей моніторингу,

# Toolkit users
$ bin/docker-compose exec -it mongo mongosh -u {{YOUR-ADMIN-USERNAME}} -p

# Switch to the "admin" database using
overleaf [direct: primary] sharelatex> use admin
switched to db admin
overleaf [direct: primary] admin> 

# Create a new role with permission to use "getParamter". Copy and paste the function below into the shell and press the return key

db.createRole(
  {
    role: "clusterParameterReader",
    privileges: [
      {
        resource: { cluster: true },
        actions: ["getParameter"]    
      }
    ],
    roles: [] 
  }
);

# Switch back to the "sharelatex" database 
use sharelatex
switched to db sharelatex
overleaf [direct: primary] sharelatex> 

# Assign the new "clusterParameterReader" role to your database user by copy and pasting the function below into the shell and press the return key 
db.grantRolesToUser(
  "{{YOUR-DATABASE-USER}}",
  [
    { role: "clusterParameterReader", db: "admin" }
  ]
);

# Type exit then return to exit the MongoDB shell
# Run bin/up -d to start the deployment stack
$ bin/up -d