template

package
v0.11.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 19, 2023 License: Apache-2.0 Imports: 6 Imported by: 0

README

Fan-out Extension Template

You can use this template as a placeholder to create your own fan-out extension.

How to use it

These are the required steps

Setup:
  • Copy and rename the folder to your extension name
  • Replace all the occurrences of template with your extension name
Implementation
  • Define the API request payloads for both Registration and Attachment
  • Implement the FanOutExtension interface. The template comes prefilled with some commented out code.
Enable extension for
  • Add it to the list of available extensions here. This will make this extension available the next time the control plane starts.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

func New(l log.Logger) (sdk.FanOut, error)

Types

type Integration

type Integration struct {
	*sdk.FanOutIntegration
}

func (*Integration) Attach

func (i *Integration) Attach(_ context.Context, req *sdk.AttachmentRequest) (*sdk.AttachmentResponse, error)

Attachment is executed when to attach a registered instance of this integration to a specific workflow

func (*Integration) Execute

func (i *Integration) Execute(_ context.Context, req *sdk.ExecutionRequest) error

Execute will be instantiate when either an attestation or a material has been received It's up to the extension builder to differentiate between inputs

func (*Integration) Register

func (i *Integration) Register(_ context.Context, req *sdk.RegistrationRequest) (*sdk.RegistrationResponse, error)

Register is executed when a operator wants to register a specific instance of this integration with their Chainloop organization

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL