docs: add project description and resource types to examples README

This commit is contained in:
“Naeel” 2026-03-09 20:23:31 +04:00
parent 0ffb905e2a
commit bd5ca39a2e

View File

@ -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"
}
```