Examples-pilot fixes #63
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,48 +1,26 @@ | ||
| #Файл конфигурации GMonit. Пожалуйста переименуйте его в ".env". | ||
|
|
||
| # Версия GMonit | ||
| TAG=v3-3135 | ||
|
|
||
| # GMonit linense key | ||
| LICENSE_KEY=xxx #укажите здесь лицензионный ключ GMonit | ||
|
|
||
| # random string - укажите случайную строку | ||
| SECRET_TOKEN=AAZtUvIaAagdlZGl0aW9uagplbnRlcnByaXN | ||
|
|
||
| # Passwords | ||
| GRAFANA_ADMIN_PASSWORD=123456789 #пароль для admin в Grafana | ||
|
Contributor
There was a problem hiding this comment. так делать нельзя, т.к. из-за ошибок у клиентов будет дефолтный пароль, и этот дефолтный пароль общедоступен
Contributor
There was a problem hiding this comment. Не совсем корректно, так как |
||
| CLICKHOUSE_PASSWORD=123456789 #задайте пароль для БД Clickhouse | ||
| POSTGRES_PASSWORD=123456789 #задайте пароль для БД PostgreSQL | ||
| COLLECTOR_DATASOURCE_PASSWORD=123456789 #задайте пароль для коллектора | ||
|
|
||
| # Domains - задайте домены и обеспечьте их разрешение | ||
| GRAFANA_DOMAIN=gmonit.example #домен для интерфейса | ||
| COLLECTOR_DOMAIN=gmonit-collector.example #домен для коллектора | ||
|
|
||
| #Certificates - сгенерированные сертификаты | ||
| CA_FILE=/gmonit/ssl/rootCA.pem | ||
| CERT_FILE=/gmonit/ssl/server.crt | ||
| KEY_FILE=/gmonit/ssl/server.key | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,213 @@ | ||
| # Инструкция по подготовке и запуску GMonit | ||
|
Contributor
There was a problem hiding this comment. файл должен называться |
||
|
|
||
| В этой инструкции описывается процесс подготовки и запуска GMonit с использованием самоподписанных сертификатов. Используется Docker Compose. | ||
|
|
||
| ## Содержание | ||
| - Настройка доменов и файла `.env` с параметрами GMonit. | ||
| - Добавление доменов в файлы `hosts`, если отсутствует DNS. | ||
| - Генерация самоподписанныч сертификаты и настроить их использование. | ||
| - Установка Docker и Docker Compose. | ||
| - Авторизация в Yandex Container Registry. | ||
| - Скачивание и подготовка базы данных GeoIP. | ||
| - Запуск GMonit и проверка его работоспособности. | ||
|
|
||
| После завершения всех шагов можно приступить к установке агентов сбора данных. | ||
|
|
||
| ## Шаги настройки | ||
|
|
||
| ### 1. Настройка доменов | ||
| Прописать в файле `.env` заранее созданные домены: | ||
| - Для коллектора | ||
| - Для Grafana | ||
|
|
||
| ### 2. Настроить .env файл | ||
| - `TAG` — версия GMonit | ||
| - `LICENSE_KEY` — ключ лицензии GMonit. | ||
| - `SECRET_TOKEN` — случайная строка (например, 32-значный алфавитно-цифровой токен). | ||
| - `GRAFANA_ADMIN_PASSWORD` — пароль для авторизации в UI GMonit. | ||
| - `CLICKHOUSE_PASSWORD` — пароль для базы данных ClickHouse. | ||
| - `POSTGRES_PASSWORD` — пароль для базы данных PostgreSQL. | ||
| - `COLLECTOR_DATASOURCE_PASSWORD` — пароль для доступа к источнику данных коллектора. | ||
| - `GRAFANA_DOMAIN` — grafana.address домен пользовательского интерфейса. | ||
| - `COLLECTOR_DOMAIN` — collector.address домен коллектора сбора данных. | ||
|
|
||
| ### 3. Добавить домены для разрешения (если без DNS) | ||
| - На машине пользователя (Windows) добавить домены в `C:\Windows\System32\drivers\etc\hosts`. | ||
| - На Linux машине: `sudo nano /etc/hosts`. | ||
|
|
||
| ### 4. Выпустить Root Certificate Authority (CA) | ||
|
Contributor
There was a problem hiding this comment. Отмечу еще, что если клиенту нужны самоподписанные сертификаты, то почти наверняка Может быть не стоит здесь давать эти рекомендации.
Author
There was a problem hiding this comment. Наша задача: сделать установку нашего дистрибутива гладкой и понятной. Я отметил, что при наличии сертификатов, эти шаги можно пропустить. А для тестовой установки проверенные шаги по генерации сертификатов позволят сотруднику не совершить ошибок при создании сертификатов.
Contributor
There was a problem hiding this comment. Чтобы не было ошибок для QA там лежали сертификаты, выпущенные на 100 лет или вроде того |
||
| - Если используются существующие сертификаты, пропустите этот и следующий шаги. | ||
| ```bash | ||
| # Всё на Linux машине | ||
| # Создать директорию для сертификатов | ||
| mkdir ~/certificates | ||
| cd ~/certificates | ||
|
|
||
| # Сгенерировать Root CA private key | ||
| openssl genrsa -out rootCA.key 2048 | ||
|
|
||
| # Выпустить Root CA certificate с увеличенным сроком действия | ||
| openssl req -x509 -new -nodes -key rootCA.key -sha256 -days 1825 -out rootCA.pem -config cert.conf | ||
|
|
||
| # Сделать Root CA certificate в crt | ||
| openssl x509 -in rootCA.pem -outform pem -out rootCA.crt | ||
| ``` | ||
|
|
||
| ### 5. Выпустить SSL-сертификат | ||
| - Создать конфигурационный файл. | ||
| ```bash | ||
| nano cert.conf | ||
|
Contributor
There was a problem hiding this comment. cat <<EOF > cert.conf
[req]
default_bits = 2048
default_md = sha256
...
EOF |
||
|
|
||
| # Пример содержимого: | ||
|
|
||
| [req] | ||
| default_bits = 2048 | ||
| default_md = sha256 | ||
| distinguished_name = req_distinguished_name | ||
| req_extensions = v3_req | ||
| prompt = no | ||
|
|
||
| [req_distinguished_name] | ||
| C = RU | ||
| ST = Moscow | ||
| L = Moscow | ||
| O = GMonitOrg | ||
| CN = *.ubuntu24 | ||
|
|
||
| [v3_req] | ||
| keyUsage = keyEncipherment, dataEncipherment, digitalSignature | ||
| extendedKeyUsage = serverAuth, clientAuth | ||
| subjectAltName = @alt_names | ||
|
|
||
| [alt_names] | ||
| DNS.1 = *.ubuntu24 | ||
| DNS.2 = ubuntu24 | ||
| DNS.3 = ui.ubuntu24 | ||
| DNS.4 = collector.ubuntu24 | ||
| ``` | ||
|
|
||
| - Выпустить сертификат. | ||
| ```bash | ||
| # Сгенерировать server private key | ||
| openssl genrsa -out server.key 2048 | ||
|
|
||
| # Создать Certificate Signing Request (CSR) с использованием cert.conf | ||
| openssl req -new -key server.key -out server.csr -config cert.conf | ||
|
|
||
| # Подписать CSR созданным Root CA с увеличенным сроком действия | ||
| openssl x509 -req -in server.csr -CA rootCA.pem -CAkey rootCA.key -CAcreateserial -out server.crt -days 1825 -sha256 -extfile cert.conf -extensions v3_req | ||
| ``` | ||
|
|
||
| ### 6. Разместить файлы сертификатов | ||
| - Скопировать созданные сертификаты в директорию `gmonit/ssl` дистрибутива GMonit. | ||
| - Файл `rootCA.crt` на сервере `sudo cp rootCA.crt /usr/local/share/ca-certificates/` -> `sudo update-ca-certificates`. | ||
|
Contributor
There was a problem hiding this comment. так нельзя делать по соображениям безопасности, и нет причины это делать
Author
There was a problem hiding this comment. Напиши пожалуйста подробнее, как надо делать.
Contributor
There was a problem hiding this comment. Тебе нужно понять что именно ты тут делаешь. |
||
| - Файл `rootCA.crt` скопировать на Windows-машину пользователя и установить (Install Certificate -> Local Machine -> Trusted Root Certification Authorities). | ||
|
|
||
| ### 7. Прописать пути к сертификатам | ||
| - Проверить, что эти сертификаты есть в `gmonit/ssl` папке. | ||
| ```bash | ||
| # Файл .env | ||
| CA_FILE=/gmonit/ssl/rootCA.pem | ||
| CERT_FILE=/gmonit/ssl/server.crt | ||
| KEY_FILE=/gmonit/ssl/server.key | ||
| ``` | ||
|
|
||
| ### 8. Установить Docker+Compose | ||
| - Проверить установку, если есть, пропускаем этот шаг. | ||
| ```bash | ||
| docker compose version | ||
| ``` | ||
| - Установить докер. | ||
| ```bash | ||
| # Подготовить систему | ||
| sudo apt-get update | ||
| sudo apt-get install \ | ||
| ca-certificates \ | ||
| curl \ | ||
| gnupg \ | ||
| lsb-release | ||
|
|
||
| # Добавить GPG-ключ Docker | ||
| curl -fsSL https://download.docker.com/linux/ubuntu/gpg \ | ||
| | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg | ||
|
|
||
| # Добавить репозиторий Docker | ||
| echo \ | ||
| "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ | ||
| $(lsb_release -cs) stable" \ | ||
| | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null | ||
|
|
||
| # Установить Docker Engine | ||
| sudo apt-get update | ||
| sudo apt-get install docker-ce docker-ce-cli containerd.io | ||
|
|
||
| # Добавить пользователя в группу docker (выйдите из системы и зайдите снова после этого) | ||
| sudo usermod -aG docker $USER | ||
|
|
||
| # Проверить плагин Docker Compose | ||
| docker compose version | ||
| ``` | ||
|
|
||
| ### 9. Авторизация в Yandex Container Registry | ||
| - Скопировать ключ Яндекс в файл `/home/user/key.json`. | ||
| - Произвести логин. | ||
| ```bash | ||
| cat key.json | docker login \ | ||
| --username json_key \ | ||
| --password-stdin \ | ||
| cr.yandex | ||
| ``` | ||
| - Проверить, что ключ сохранился. | ||
| ```bash | ||
| cat ~/.docker/config.json | ||
| ``` | ||
| - После успешного выполнения key.json можно с машины удалить. | ||
|
|
||
| ### 10. Скопировать gmonit каталог на сервер | ||
| - `gmonit` скопировать в `/home/user/`. | ||
|
|
||
| ### 11. Загрузить базу данных GeoIP | ||
| - Проверить текущую версию базы данных и ссылку на `https://db-ip.com/db/download/ip-to-city-lite`. | ||
| - Скачать базу данных на сервере. | ||
| ```bash | ||
| # Зайти в папку gmonit | ||
| cd ~/gmonit | ||
|
|
||
| # Загрузить базу данных GeoIP | ||
| wget https://download.db-ip.com/free/dbip-city-lite-2025-01.mmdb.gz | ||
|
|
||
| # Распаковать скачанный файл | ||
| gzip -d *.mmdb.gz | ||
|
|
||
| # Переименование файла для использования в GMonit | ||
| mv "$(find . -maxdepth 1 -name '*.mmdb' | head -n 1)" geoip.mmdb | ||
| ``` | ||
|
|
||
| ### 12. Запуск приложения | ||
| ```bash | ||
| cd ~/gmonit | ||
|
|
||
| # Обновить образы Docker (опционально) | ||
| docker compose pull | ||
|
|
||
| # Запустить контейнеры и ожидать их готовности | ||
| docker compose up --wait | ||
| ``` | ||
| ## Проверить, что работает | ||
| - Проверить статус контейнеров. | ||
| ```bash | ||
| docker compose ps | ||
| ``` | ||
| - Зайти на сервер, убедиться, что открывается. | ||
| ```bash | ||
| https://grafana.address | ||
| ``` | ||
| - Такой запрос к коллектору должен вернуть JSON с версией. | ||
| ```bash | ||
| https://collector.address/about | ||
| ``` | ||
|
|
||
| ## Редкации и проверка | ||
| Редакция инструкции от 18 января 2025 года. | ||
| Проверено на Ubuntu 24.04.1 LTS. 18 января 2025 года. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Это приведет к ошибкам, не стоит прописывать конкретные значения.
Например, кто-то забудет и будет использовать старую версию
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Нам обязательно надо указывать ту версию, на которой проверялся этот дистрибутив. Поэтому считаю, что надо указывать версию на которой этот дистрибутив проходил QA.