fix: document cron router auth chain
This commit is contained in:
+47
@@ -0,0 +1,47 @@
|
||||
# Fission TimeTrigger CRD
|
||||
|
||||
В официальной CRD Reference Fission cron-триггер называется `TimeTrigger`.
|
||||
|
||||
## Kind
|
||||
|
||||
- `apiVersion`: `fission.io/v1`
|
||||
- `kind`: `TimeTrigger`
|
||||
|
||||
## Назначение
|
||||
|
||||
`TimeTrigger` запускает функцию по расписанию, заданному cron-строкой.
|
||||
|
||||
## Spec
|
||||
|
||||
Согласно официальной схеме, у `TimeTriggerSpec` есть поля:
|
||||
- `cron` — cron schedule
|
||||
- `functionref` — ссылка на функцию
|
||||
- `method` — HTTP method для вызова функции, по умолчанию `POST`
|
||||
- `subpath` — под-путь для маршрутизации внутри функции, по умолчанию `/`
|
||||
|
||||
## FunctionReference
|
||||
|
||||
`functionref` содержит ссылку на функцию:
|
||||
- `type` — тип ссылки, для time trigger используется `name`
|
||||
- `name` — имя функции
|
||||
|
||||
## Минимальный пример
|
||||
|
||||
```yaml
|
||||
apiVersion: fission.io/v1
|
||||
kind: TimeTrigger
|
||||
metadata:
|
||||
name: cron-job
|
||||
namespace: fission-function
|
||||
spec:
|
||||
cron: "*/5 * * * *"
|
||||
functionref:
|
||||
type: name
|
||||
name: hello
|
||||
```
|
||||
|
||||
## Что важно помнить
|
||||
|
||||
- `TimeTrigger` вызывает функцию через HTTP-вызов.
|
||||
- Если функция внутри сама поддерживает routing, `subpath` помогает выбрать нужный маршрут.
|
||||
- `method` можно использовать, если триггер должен дергать функцию не `POST`, а `GET`, `PUT`, `DELETE` или `HEAD`.
|
||||
Reference in New Issue
Block a user