cai

Documentation

Overview

Package cai helps with Cloud Asset Inventory

Index

• func BuildAncestorsDisplayName(ctx context.Context, ancestors []string, collectionID string, ...) []string
• func BuildAncestryPath(ancestors []string) string
• func GetAssetContact(contactRole string, resourceJSON json.RawMessage) (string, error)
• func GetAssetShortTypeName(assetType string) string
• type FeedDeployment
  • func NewFeedDeployment() *FeedDeployment
  • func (feedDeployment *FeedDeployment) Deploy() (err error)
• type FeedMessageGroup
• type FeedMessageGroupSettings
• type FeedMessageMember
• type Parameters
• type Window

Functions

func BuildAncestorsDisplayName

func BuildAncestorsDisplayName(ctx context.Context, ancestors []string, collectionID string, firestoreClient *firestore.Client, cloudresourcemanagerService *cloudresourcemanager.Service, cloudresourcemanagerServiceV2 *cloudresourcemanagerv2.Service) []string

BuildAncestorsDisplayName build a slice of Ancestor friendly name from a slice of ancestors

func BuildAncestryPath

func BuildAncestryPath(ancestors []string) string

BuildAncestryPath build a path from a slice of ancestors

func GetAssetContact

func GetAssetContact(contactRole string, resourceJSON json.RawMessage) (string, error)

GetAssetContact retrieve owner of resolver contact from asset labels and parent labels

func GetAssetShortTypeName

func GetAssetShortTypeName(assetType string) string

GetAssetShortTypeName returns a short version of asset type <serviceName>-<assetType>, like bigquery-Dataset. It deals with k8s exceptions

Types

type FeedDeployment

type FeedDeployment struct {
	Artifacts struct {
		TopicName    string `yaml:"topicName"`
		FeedName     string `yaml:"feedName"`
		ContentType  assetpb.ContentType
		FeedFullName string `yaml:"FeedFullName"`
	}
	Core     *deploy.Core
	Settings struct {
		Instance struct {
			CAI Parameters
		}
	}
}

FeedDeployment settings and artifacts structure

func NewFeedDeployment

func NewFeedDeployment() *FeedDeployment

NewFeedDeployment create deployment structure

func (*FeedDeployment) Deploy

func (feedDeployment *FeedDeployment) Deploy() (err error)

Deploy get-create resource feeds, get-create-update the iam policies feed

type FeedMessageGroup

type FeedMessageGroup struct {
	Asset   assetGroup `json:"asset"`
	Window  Window     `json:"window"`
	Deleted bool       `json:"deleted"`
	Origin  string     `json:"origin"`
}

FeedMessageGroup CAI like format

type FeedMessageGroupSettings

type FeedMessageGroupSettings struct {
	Asset   assetGroupSettings `json:"asset"`
	Window  Window             `json:"window"`
	Deleted bool               `json:"deleted"`
	Origin  string             `json:"origin"`
}

FeedMessageGroupSettings CAI like format

type FeedMessageMember

type FeedMessageMember struct {
	Asset   assetMember `json:"asset"`
	Window  Window      `json:"window"`
	Deleted bool        `json:"deleted"`
	Origin  string      `json:"origin"`
}

FeedMessageMember CAI like format

type Parameters

type Parameters struct {
	Parent       string
	ContentType  string   `yaml:"contentType" valid:"isNotZeroValue"`
	AssetTypes   []string `yaml:"assetTypes" valid:"isNotZeroValue"`
	CronSchedule string   `yaml:"cronSchedule,omitempty"`
}

Parameters structure

type Window

type Window struct {
	StartTime time.Time `json:"startTime" firestore:"startTime"`
}

Window Cloud Asset Inventory feed message time window