Руководство по системному администрированию#

Сценарии администрирования#

Все сценарии администрирования, описанные в данном разделе, выполняются пользователем с ролью Admin. Логин и пароль для первоначального входа предоставляется при установке компонента.

Интерфейс области администрирования (Admin area) выглядит следующим образом:

Создание пользователя#

1. Перейдите в раздел Admin area через меню приложения.

2. Перейдите в раздел Users и нажмите кнопку New user:

3. На странице создания нового пользователя заполните поля Name, Username и Email и проставьте настройки в блоке Access:

   • Поле 1: укажите 0.

   • Поле 2: снимите галочку в чекбоксе Can create group.

   • Поле 3: выберите Regular.

   • Поле 4: поставьте галочку в чекбоксе External.

4. Все остальные поля оставьте без изменений и создайте пользователя.

5. В разделе Identity пользователя создайте новый identity:

После создания пользователя его необходимо добавить в нужную группу или проект с указанием роли пользователя.

Обзор всего instance#

1. Отчеты по состоянию instance: общая статистика по количеству проектов, групп, компонентов, запущенных runners, активных features.

2. Проекты: список всех проектов с возможностью удалить (кнопка Delete), редактировать (кнопка Edit) или создать новый (кнопка New Project).

3. Пользователи: список всех пользователей instance с возможностью блокировать (кнопка Block), удалять (кнопка Delete User), удалять со всеми действиями (кнопка Delete with contributions), а также редактировать параметры пользователя (доступны для редактирования имя, почта, пароль, уровень доступа, ссылки на социальные сети). Также по нажатию на кнопку New user открывается форма создания нового пользователя.

4. Группы: список всех существующих групп с возможностью удалять (кнопка Delete), редактировать (кнопка Edit) или создавать новую группу с помощью кнопки New group.

5. Темы для обсуждений: можно создавать ветку для обсуждения и редактировать или удалять существующие темы.

6. Jobs: список всех jobs в приложении с возможностью перезапускать job в статусе Failed (статус Неудачно).

7. Runners: список runners с возможностью остановить, удалить или отредактировать их.

8. Информация о существующих Gitaly серверах: список, содержащий информацию о типе хранения, адресе расположения, версии сервера, версии git и состоянии.

Управление задачами#

1. Статусы: возможность создания новых, редактирования и удаления существующих статусов.

2. Управление workflow: можно создавать новые workflow (кнопка Create workflow), копировать, редактировать и удалять существующие.

3. Группы и проекты: списки существующих групп и проектов.

Аналитика#

1. DevOps отчет: отображает метрики использования ресурсов за последние 30 дней.

2. Тренды использования: статистика, отображающая следующие показатели:

   1. Суммарное количество пользователей.

   2. Суммарное количество проектов и групп.

   3. Статистику по pipelines: суммарное количество, успешные, неуспешные, отменённые и пропущенные.

   4. Суммарное количество задач и запросов на слияние.

Мониторинг#

1. Информация о системе: количество ядер, использование памяти.

2. Информация о фоновых миграциях, их состоянии выполнения и финальном статусе.

3. Фоновые jobs: отображает графики работы фоновых jobs.

4. Проверка на ошибки: отображает статус автопроверки ошибок.

5. Информация о профайлах запросов.

Рассылка информационного сообщения#

Отправка всем пользователям приложения информационного сообщения со следующими возможностями:

1. Заполнить контент сообщения.

2. Выбрать тип сообщения (баннер или оповещение).

3. Выбрать цвет фона.

4. Предоставить пользователю возможность закрыть это сообщение.

5. Указать конкретный путь (проект, группа, весь instance).

6. Дата начала трансляции сообщения.

7. Дата завершения трансляции сообщения.

Системные хуки#

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

1. Указать ссылку целевой системы.

2. Указать токен доступа.

3. Выбрать триггер, по срабатыванию которого будут отсылаться данные:

   1. События обновления репозитория.

   2. Push-события: любые слияния веток вызывают отправку во внешнюю систему.

   3. Push в репозиторий нового тега.

   4. События запросов слияния: их создание, обновление или слияние.

4. Включить/выключить SSL верификацию.

Приложения#

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

Отчет о злоупотреблениях#

Отчет содержит список сообщений о злоупотреблениях и отображает следующую информацию:

1. Логин пользователя, на кого оставлена жалоба.

2. Логин пользователя, который оставил жалобу.

3. Сопроводительное сообщение.

4. Список действий:

   1. Удалить жалобу и пользователя.

   2. Заблокировать пользователя.

   3. Удалить жалобу.

Ключи развертывания#

Просмотр списка созданных ключей и возможность создать новый (необходимо указать название и сгенерировать публичный ключ развертывания).

Метки#

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

1. Удалить существующую.

2. Редактировать существующую.

3. Создать новую метку:

   1. Необходимо заполнить Название.

   2. Краткое описание метки.

   3. Выбрать цвет метки.

Настройки#

1. Общие:

   1. Настройка видимости и доступов.

   2. Управление лимитами.

   3. Управление размерами diff-файлов.

   4. Настройка правил создания новых аккаунтов пользователями.

   5. Настройка правил входа в систему.

   6. Добавление правила использования и политик приватности.

   7. Настройка возможности удаленной авторизации из внешних систем.

   8. Указание максимального количество сессий для веб-терминала.

   9. Включение/выключение "живого" ревью в веб-редакторе.

   10. Подключение Gitpod.

   11. Подключение Kroki.

   12. Подключение сервиса Mailgun.

   13. Подключение сервиса PlantUML.

   14. Включение/выключение внешних запросов.

   15. Подключение сервиса Snowpow.

   16. Подключение Amazon EKS.

   17. Включение/выключение FLoC.

2. Список интеграций, с возможностью деактивировать их.

3. Репозиторий:

   1. Установка стандартного название ветки.

   2. Включение/выключение зеркалирования репозитория.

   3. Настройка хранения репозитория:

      1. Включение/выключение хэширования путей.

      2. Указание количества nodes для новых репозиториев.

   4. Обслуживание репозитория:

      1. Включение/выключение автоматических проверок состояния репозитория.

      2. Включение/выключение автоматического обработчика.

   5. Подключение внешнего хранилища репозитория.

4. Настройка CI/CD.

5. Настройка анти-бот и анти-спам защиты.

6. Настройка обмена метриками:

   1. Prometheus.

   2. Grafana.

   3. Разрешить/запретить видеть метрики пользователям без прав администратора.

   4. Активация/деактивация самомониторинга приложения.

   5. Включение/выключение автопроверки версии и проверки сервиса.

7. Настройка сети.

8. Настройка внешнего вида системы (логотип для шапки приложения, иконка вкладки браузера, контент для шапки и подвала приложения, контент для страницы логирования, новых проектов и страниц пользователей).

9. Настройка предпочтений:

   1. Настройка почтовых уведомлений:

      1. Включать или нет автора в уведомление.

      2. Включить возможность разбивать сообщение на несколько писем.

      3. Имя домена для приватных рассылок.

      4. Включить оповещение о деактивации пользователей.

   2. Настройка начальной страницы и справки: добавление ссылок на документацию.

   3. Подключение документации в виде Pages.

   4. Настройка частоты обновления UI.

   5. Установка timeout для Gitaly.

   6. Настройка локализации.

   7. Настройка параметров jobs Sidekiq.

События системного журнала#

Для просмотра лога системных событий необходимо открыть файл application_json.log, который располагается, в зависимости от способа установки:

1. /var/log/gitlab/gitlab-rails/application_json.log

2. /home/git/gitlab/log/application_json.log

Доступные уровни логирования:

• 0 DEBUG

• 1 INFO

• 2 WARN

• 3 ERROR

• 4 FATAL

• 5 UNKNOWN

В данном файле содержится информация о системных событиях в формате json.

Включение уровня логирования Debug не рекомендуется в промышленных инсталляциях.

Уровень логирования настраивается через переменную окружения GITLAB_LOG_LEVEL

Доступны 5 уровней логирования - DEBUG, INFO, WARN, ERROR, FATAL, UNKNOWN

При выборе уровня логирования DEBUG будут логироваться события уровня DEBUG, INFO, WARN, ERROR, FATAL, UNKNOWN … При выборе уровня логирования UNKNOWN будут логироваться события уровня UNKNOWN

Пример события уровня INFO:

{  
   "severity": "INFO",
   "time": "2018-10-17T17:38:22.523Z",
   "author_id": 3,
   "entity_id": 2,
   "entity_type": "Project",
   "change": "visibility",
   "from": "Private",
   "to": "Public",
   "author_name": "John Doe4",
   "target_id": 2,
   "target_type": "Project",
   "target_details": "namespace2/project2" 
}

Пример события уровня DEBUG:

{
   "severity":"DEBUG",
   "time":"2022-12-13T12:11:41.026Z",
   "correlation_id":null,
   "message":"ActiveRecord connection established"
}

Пример события уровня WARN:

{
   "severity":"WARN",
   "time":"2022-12-13T06:10:28.757Z",
   "correlation_id":null,
   "message":"Gitlab::Metrics::Samplers::RubySampler: uninitialized constant Gitlab::Metrics::Samplers::RubySampler::System"
}

Пример события уровня ERROR:

{
   "severity":"ERROR",
   "time":"2022-12-13T14:54:29.889Z",
   "correlation_id":"bf1b14ac1b289a83e3508e93f50e4db0",
   "message":"Cannot obtain an exclusive lease for namespace:namespaces_root_statistics:55. There must be another instance already in execution."
}

События мониторинга#

Модули компонента не порождают метрики мониторинга.

Часто встречающиеся проблемы и пути их устранения (FAQ)#

Типовые проблемы в текущей версии не выявлены.

В случае сбоев диагностику следует начинать со следующих проверок:

1. Проверка наличия стабильного соединения по сети.

2. Проверка корректности вводимых логина и пароля (в случае неудачи авторизации).