Expand description
What crosses between Alien and an extension’s hooks module: the hooks the module declares, and the input and output of each kind of hook.
Every value crosses as JSON in the serde forms below. The extension SDK writes them inside the
module and the hosts that call hooks read them, so both sides compile against these types.
Where a hook returns a type a format crate owns (a CloudFormation template, a resource or an
expression), HookKind names it and it crosses in that type’s own serde form.
Structs§
- Emit
Input - What an emitter gets: the parts of Alien’s
EmitContextthat serialize. - Helm
Fragment Output - What a Helm emitter returns.
- Helm
Infrastructure Value - One entry under
infrastructure:in a chart’svalues.yaml. - Helm
Modifier Output - What a Helm modifier returns.
- Hook
Entry - One hook the module declares.
- Hook
Error - A hook’s error as it crosses back to the host: the hook’s code and message, and whether
another try may pass. The host keeps the code when it is a short
[A-Z0-9_]token and the retry flag, and cuts the message short. Only an error that setsretryableitself is retried; one converted from anAlienErroris final, since a hook gives the same answer to the same input. - Hooks
Manifest - The hooks a module declares, as its
alien_hooks_manifestexport returns them. - Import
Input - What an importer gets: the parts of Alien’s
ImportContextthat serialize, and the data the setup template returned. - Import
Output - What an importer returns. The controller state carries no type tag or state version, which only Alien writes.
- Intercepted
Request - A request as an interceptor sees it: no credential headers, and a text body or none.
- Intercepted
Response - A response as an interceptor sees it.
- Link
Output - What a link returns for a workload that links the resource.
- Template
Files - A Terraform module or a Helm chart, file by file.
- Terraform
Fragment - The blocks a Terraform emitter returns, each list as HCL text.
- Terraform
Modifier Output - What a Terraform modifier returns.
Enums§
- Emit
Method - Which method of an emitter a call runs.
- Hook
Kind - The kinds of hook a module can declare. A module that declares any other kind is refused at load, since no host could call that hook.
- Intercepted
Cloud - The API a call goes to.
- Interceptor
Input - A call to an interceptor, by what it asks.
- Interceptor
Output - An interceptor’s answer.