publish2fs

Documentation

Overview

Package publish2fs publish assets resource feeds as FireStore documents. Create, Update, Delete - Triggered by: resource or IAM policies assets feed messages in PubSub topics - Instances:

• one per asset type to be persisted in FireStore
• ussually 3: organizations, folders and projects

- Output: FireStore documents created, updated, deleted - Cardinality: one-one, one feed message - one operation performed in FireStore - Automatic retrying: yes - Required environment variables:

• COLLECTION_ID the name of the FireStore collection grouping all assets documents

Index

• func EntryPoint(ctxEvent context.Context, PubSubMessage ram.PubSubMessage, global *Global) error
• func Initialize(ctx context.Context, global *Global)
• type Asset
• type FeedMessage
• type Global

Functions

func EntryPoint

func EntryPoint(ctxEvent context.Context, PubSubMessage ram.PubSubMessage, global *Global) error

EntryPoint is the function to be executed for each cloud function occurence

func Initialize

func Initialize(ctx context.Context, global *Global)

Initialize is to be executed in the init() function of the cloud function to optimize the cold start

Types

type Asset

type Asset struct {
	Name         string                 `json:"name" firestore:"name"`
	AssetType    string                 `json:"assetType" firestore:"assetType"`
	Ancestors    []string               `json:"ancestors" firestore:"ancestors"`
	AncestryPath string                 `json:"ancestryPath" firestore:"ancestryPath"`
	IamPolicy    map[string]interface{} `json:"iamPolicy" firestore:"iamPolicy,omitempty"`
	Resource     map[string]interface{} `json:"resource" firestore:"resource"`
}

Asset Cloud Asset Metadata

type FeedMessage

type FeedMessage struct {
	Asset   Asset      `json:"asset" firestore:"asset"`
	Window  ram.Window `json:"window" firestore:"window"`
	Deleted bool       `json:"deleted" firestore:"deleted"`
	Origin  string     `json:"origin" firestore:"origin"`
}

FeedMessage Cloud Asset Inventory feed message

type Global

type Global struct {
	// contains filtered or unexported fields
}

Global structure for global variables to optimize the cloud function performances