From bd5ca39a2e45a530eefce89e92e6e1edd1599b66 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CNaeel=E2=80=9D?= Date: Mon, 9 Mar 2026 20:23:31 +0400 Subject: [PATCH] docs: add project description and resource types to examples README --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 5bf4e0e..5b69fd3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,23 @@ # Примеры sless +## Что такое sless + +**sless** — платформа для запуска serverless-функций в Kubernetes-кластере. + +Ты пишешь код на Python или Node.js, кладёшь в папку, а платформа сама собирает Docker-образ, деплоит и публикует HTTP-эндпоинт. Всё управляется через Terraform. + +### Ресурсы + +| Ресурс | Что делает | +|---|---| +| `sless_function` | Загружает код, собирает образ и запускает функцию в кластере | +| `sless_trigger` | Публикует функцию — либо как HTTP-эндпоинт, либо по расписанию (cron) | +| `sless_job` | Запускает функцию один раз (например, для инициализации БД) и ждёт результата | + +**Типичный сценарий:** создаёшь `sless_function` с кодом → добавляешь `sless_trigger` с `type = "http"` → получаешь публичный URL вида `https://sless-api.kube5s.ru/fn/default/имя-функции`. + +--- + Примеры показывают различные сценарии использования serverless функций через Terraform провайдер `terra.k8c.ru/naeel/sless`. ## Требования @@ -14,6 +32,7 @@ ```hcl provider "sless" { endpoint = "https://sless-api.kube5s.ru" + token = "dev-token-change-me" } ```