При увеличении размеров команды зачастую требуется документировать и управлять накопленными знаниями. Данный подход позволяет командам эффективней работать, а новичкам в сфере самостоятельно разобраться с материалом. Публичные ресурсы Google Docs, Notion и прочие открывают доступ к вашей коммерческой тайне администраторам площадки, а так же не всегда бывают удобны в работе. В данном материале разберемся, как поднять свою wiki в корпоративном сегменте сети и сделать это безопасно!
Что такое Confluence?
Confluence – это Wiki-платформа, позволяющая организовать накопленные знания и материалы в едином пространстве для сотрудников. Представляет собой сервер с веб-панелью, на который можно зайти по стандартному логину/паролю или подключить внешнюю систему аутентификации. Кроме стандартных задач позволяет заниматься анализом, ретроспективой, менеджерить таски команды и многое другое, благодаря встроенным шаблонам.
Так как сотрудники имеют разный доступ к информации, то предусмотрена система разграничения доступа, которая определяет к какой информации сотрудник может получить доступ.
Как реализован Confluence и какие у него требования?
Платформа состоит из сервисов, которые обеспечивают работу: веб-сервера, базы данных, кэширующий сервер, а так же сервера приложения с различными модулями от аутентификации до обработчиков запросов.
Пользователь обращается к веб-серверу и предоставляет свои данные аутентификации. Запрос попадает в веб-приложение, архитектура, которого представлена выше и проходит аутентификацию на сервере. После чего запрос проходит обработку на веб-приложении и возвращает ответ клиенту. В процессе обработки запросов веб-приложение может обращаться к БД и вносить изменения.
Инсталляция происходит через Docker-образ, который позволяет в несколько действий установить продукт изолированно от остальных сервисов на машине. Все архитектурные компоненты уже идут в комплекте образа и поднимаются автоматически после создания контейнера на сервере. Для работы необходимо обеспечить ряд минимальных требований:
- Процессор: 2 ядра, 2.0 ГГц или выше;
- Оперативная память: 4 ГБ (базовая установка с небольшим количеством пользователей и минимальной нагрузкой);
- Место на диске: минимум 10 ГБ свободного места для установки Confluence, плюс дополнительное место для хранения данных (зависит от размера базы данных и файловых вложений).
Для быстрой и эффективной работы базы знаний необходимо:
- Процессор: 4 ядра, 2.5 ГГц или выше;
- Оперативная память: 8 ГБ и выше, особенно для среды с большим количеством пользователей и активностью.;
- Место на диске: 50 ГБ и более, учитывая растущие потребности в хранении данных, резервных копий и логов.
К примеру, для базовой работы wiki-системы на 150 аккаунтов, 30 пространств и 1000 страниц потребуется около 6 гб ОЗУ, 2 ядра и около 25 ГБ свободного места на диске.
Если у вас недостаточно мощностей, то можно заказать облачный сервер от Serverspace, для этого перейдем к созданию сервера, на любой из двух платформ vStack cloud или же VMware cloud. Нажмем на кнопку Создать сервер и выберем конфигурацию, подходящую под наши задачи, затем нажмем кнопку Создать:
Как быстро установить Confluence?
Установим контейнерный менеджер Docker, при работе необходимо учесть версию ОС для установки на сайте компании. В нашем случае установка Docker происходит на RHEL подобной ОС.
sudo dnf install -y yum-utils
sudo yum-config-manager --add-repo https://download.docker.com/linux/rhel/docker-ce.repo
sudo dnf update && sudo dnf install docker-ce
sudo systemctl start docker && sudo systemctl enable docker
После установки необходимо загрузить образ самой Confluence, для этого выполним команду:
Образ или архив был помещен в локальное хранилище, и теперь при создании контейнера на основе этого образа, docker daemon сможет найти его на устройстве. Для работы системы так же необходимо создать виртуальный том, он будет отделен от основной файловой системы ОС. Данный подход гарантирует изолированность ресурсов Wiki и возможности гибко управлять сервисом:
Перейдем к запуску Confluence, а соответсвенно и конфигурации контейнера, среды в которой будет запущена Wiki:
Рассмотрим и опишем параметры данной команды:
- docker run – команда запуска контейнера на основе образа;
- -v /confluencee:/var/atlassian/application-data/confluence – подключение изолированного тома к файловой системе контейнера, где слева том, а справа файловая система контейнера;
- –name=”confluencee” – имя контейнера, для упрощенного обращения по имени;
- -d или detach для запуска контейнера в фоне;
- -p проброс портов с контейнера на хостовую машину;
- atlassian/confluence – сам образ с исходниками и файлом автоматизации.
Данная команда позволит запустить Confluence в отдельной среде и все необходимые сервисы для работы. Управление происходит через веб-панель, для этого перейдем по внешнему или локальному адресу устройства через браузер. Для настройки и тестирования подойдет обращение формата:
Вставьте свой лицензионный ключ или приобретите на сайте правообладателя по нажатию на Get an evaluation license. После чего нажмите кнопку Next.
Для установки выберите один из типов развертывания: одиночная нода или же кластер. Второй тип используется, при больших затратах и требованиях к количеству пользователей, а первый для маленьких и средних объёмов, где справится один сервер. После того, как выбран тип установки – выберем шаблон.
Возможно использовать пример существующей wiki, либо же собрать пустую страницу, которую в дальнейшем можно будет оформить с нуля.
Укажем данные для учетной записи администратора Wiki и сохраним, нажав кнопку Next. После чего определим пространство, это может быть группа для команды или для всей организации. Все зависит от того, как вы продумаете структуру базы знаний.
В результате всех манипуляций открывается рабочая панель для Wiki, где описаны базовые возможности сервиса
Более глубокую настройку можно провести, нажав шестеренку слева сверху, для того чтобы начать формировать базу знаний используйте сверху кнопку To create. Выбрав шаблон, через многоточие можно структурировать базу для большинства задач команды.