---
metadata:
  - name: generator
    content: Diplodoc Platform v5.63.0
alternate:
  - ru/cookbook/introduction
  - href: ru/cookbook/introduction.md
    type: text/markdown
    title: Markdown version
csp:
  - script-src:
      - https://mc.yandex.ru
    img-src:
      - https://mc.yandex.ru
    connect-src:
      - https://mc.yandex.ru
      - wss://mc.yandex.ru
    child-src:
      - 'blob:'
      - https://mc.yandex.ru
    frame-src:
      - 'blob:'
      - https://mc.yandex.ru
    frame-ancestors:
      - 'blob:'
      - https://mc.yandex.ru
canonical: ru/cookbook/introduction.html
title: Введение в DataLens On-premises
description: >-
  Из статьи вы узнаете, какую информацию можно получить в разделе рецептов
  администратора DataLens On-premises.
vcsPath: ru/cookbook/introduction.md
---

# Введение

{% note info %}

**DataLens On-premises** — это сервис для бизнес-аналитики. Он позволяет подключаться к различным источникам данных, строить визуализации, собирать дашборды и делиться результатами.

{% endnote %}

После изучения материалов вы сможете самостоятельно развертывать, настраивать, обновлять и поддерживать DataLens On-premises.

## После ознакомления вы сможете {#skills}

* определить требования к виртуальной машине или кластеру для развертывания дистрибутива;
* установить дистрибутив и построить отказоустойчивую архитектуру;
* настроить конфигурацию и функции сервиса;
* настроить сбор логов;
* настроить авторизацию пользователей и выдать нужные права сотрудникам;
* подключить данные;
* подключить Яндекс Карты и Editor;
* сделать резервное копирование и восстановление баз данных.

## Для успешного изучения материалов вам потребуется {#basic-requirements}

* базовое понимание особенностей облачных вычислений;
* понимание работы k8s и особенностей развертывания приложений;
* знание принципов контейнеризации;
* опыт работы с Linux, Bash-командами и терминалом;
* опыт работы с Helm-чартами (опционально).

## Какие рецепты есть в документации {#content}

1. **Архитектура DataLens**
    * Назначение сервиса и его основные компоненты.
    * Основные функциональные особенности сервиса.
    * Задачи, которые сервис позволяет решать бизнес-пользователям.
    * Внутреннее устройство сервиса.
1. **Подготовка дистрибутива: требования к ВМ и кластеру**
    * Как получить доступ к дистрибутиву.
    * Ресурсы, которые потребуются для установки.
    * Как масштабировать конфигурацию по количеству пользователей.
1. **Базовая установка для быстрого старта и тестового окружения**
    * Как установить сервис на виртуальную машину со встроенным K3s.
    * Управление доступом администратора: получение и сброс пароля.
    * Как зеркалировать Docker-образы для закрытых контуров.
    * Структура дистрибутива.
1. **Установка для промышленной эксплуатации**
    * Использование файла конфигурации для параметризации системы.
    * Развертывание с внешним кластером PostgreSQL.
    * Использование собственных TLS-сертификатов вместо самоподписанных.
    * Рекомендации по проектированию отказоустойчивой архитектуры.
    * Обзор сервисов дистрибутива и их сетевого взаимодействия.
1. **Включение функций, мониторинг и отладка**
    * Как включать и отключать функции через `values.yaml` и `init.sh`.
    * Обзор ключевых функций: экспорт, файловые коннекторы, Editor, Usage Tracking.
    * Особенности настройки при использовании внешних ClickHouse® и S3.
    * Мониторинг и сбор логов для отладки.
1. **Сбор логов**
    * Работа с двумя типами логов: для работы приложения и для использования (Usage Tracking).
    * Использование инструментов для сбора логов: от всех сервисов или до одного конкретного.
    * Как собирать события кластера для диагностики проблем развертывания.
    * Использование продвинутых инструментов отладки: `k9s` и `get-debug-info`.
    * Настройка Usage Tracking с использованием внешней ClickHouse®.
1. **Подключение данных**
    * Создание простого подключения к базе данных.
    * Настройка и использование файловых подключений.
    * Работа с коннекторами
1. **Подключение специфичных функций**
    * Как подключать Яндекс Карты.
    * Как работать с Editor для создания визуализаций.
1. **Миграция и резервное копирование**
    * Два подхода: бэкап всей системы vs экспорт/импорт объектов.
    * Резервное копирование и восстановление служебной БД PostgreSQL.
    * Важность сохранения `CONTROL_API_CRYPTO_KEY` при восстановлении.
    * Экспорт и импорт воркбуков для переноса контента.
    * Сценарий миграции: с Yandex DataLens на DataLens On-premises.
1. **Авторизация**
    * Работа с двухуровневой моделью прав: глобальные роли и права на объекты.
    * Настройка интеграции с LDAP на примере Active Directory.
    * Настройка интеграции по протоколу OpenID Connect (OIDC).
    * Автоматическая синхронизация групп.
1. **Типовые проблемы**
    * Проблемы, с которыми вы можете столкнуться при использовании DataLens On-premises, и варианты их решения.
1. **Полезные команды**
    * Список команд, которые пригодятся при администрировании DataLens On-premises.

## В каком порядке изучать материалы {#order-study}

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

Например, вы уже развернули дистрибутив и выполнили установку DataLens On-premises. Теперь ваши рабочие задачи — настроить конфигурацию и оптимизировать работу системы. В таком случае можете начать со статьи [«Включение функций, мониторинг и отладка»](./configuration.md), в которой разбираются эти вопросы.

Если вы еще не установили дистрибутив и просто изучаете материалы, рекомендуем читать статьи последовательно.

## Время изучения материалов {#time-study}

Изучение всех материалов займет примерно 6 часов.

Вы познакомились с содержанием и можете переходить к изучению статей.