services/

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/BrunoReboul/ram

Links

Open Source Insights

README ¶

Service packages structure

All service cloud function packages share a consistent structure

Two functions and one type

`Initialize` function

Goal
- Optimize cloud function performance by reducing the invocation latency
Implementation
- Is executed once per cloud function instance as a cold start.
- Cache objects expensive to create, like clients
- Retreive settings once, like environment variables
- Cached objects and reteived settings are exposed in one global variable named global

`Global` type

A struct to define a global variable carrying cached objects and retreived settings by Initialized function and used by EntryPoint function

`EntryPoint` function

Goal
- Execute operations to be performed each time the cloud function is invoked
Implementation
- Is executed on every event triggering the cloud function
- Uses cached objects and retreived settings prepared by the Initialized function and carried by a global variable of type Global
- Performs the task a given service is targetted to do that is described before the package key word

Automatic retrying

Automatic retrying is consistently implemented in RAM service packages as documented in Google Cloud Function best practice Retrying Background Functions

Impact on cloud functions Stackdriver logs:

Errors entry in log only appears for transient errors.
- As en error is reported the function is retried.
Other errors and loged as information to avoid unwanted retries
- To find errors in such cloud function logs you can use the following Stackdriver logging filter

resource.type="cloud_function"
textPayload:"error"

Directories ¶

Path	Synopsis
dumpinventory Package dumpinventory request CAI to perform an export Triggered by Cloud Scheduler Job, through PubSub messages.	Package dumpinventory request CAI to perform an export Triggered by Cloud Scheduler Job, through PubSub messages.
getgroupsettings Package getgroupsettings retreives the settings of one group from `Groups Settings API` Triggered by PubSub messages from the GCI groups topic.	Package getgroupsettings retreives the settings of one group from `Groups Settings API` Triggered by PubSub messages from the GCI groups topic.
listgroupmembers Package listgroupmembers extract all members from a group in GCI directory using the Admin SDK API Triggered by PubSub messages from the GCI groups topic.	Package listgroupmembers extract all members from a group in GCI directory using the Admin SDK API Triggered by PubSub messages from the GCI groups topic.
listgroups Package listgroups extract all groups from a GCI directory using the Admin SDK API Triggered by Cloud Scheduler Job, through PubSub messages.	Package listgroups extract all groups from a GCI directory using the Admin SDK API Triggered by Cloud Scheduler Job, through PubSub messages.
monitorcompliance Package monitorcompliance check asset compliance Triggered by Resource or IAM policies assets feed messages in PubSub topics.	Package monitorcompliance check asset compliance Triggered by Resource or IAM policies assets feed messages in PubSub topics.
publish2fs Package publish2fs publish assets resource feeds as FireStore documents It manages creation, updates and delete.	Package publish2fs publish assets resource feeds as FireStore documents It manages creation, updates and delete.
splitdump Package splitdump nibble large CAI dumps into PubSub asset feed messages One dump line = one PubSub message.	Package splitdump nibble large CAI dumps into PubSub asset feed messages One dump line = one PubSub message.
stream2bq Package stream2bq stream from PubSub to BigQuery 1) assets 2) compliance states 3) violations - Triggered by: Messages in related PubSub topics - Instances: one per Big Query table - assets - compliance states - violations - Output: Streming into BigQuery tables - Cardinality: one-one, one pubsub message - one stream insert in BQ - Automatic retrying: yes - Required environment variables: - ASSETSCOLLECTIONID the name of the FireStore collection grouping all assets documents - BQ_DATASET name of the Big Query dataset hosting the table - BQ_TABLE name of the Big Query table where to insert streams - OWNERLABELKEYNAME key name for the label identifying the asset owner - VIOLATIONRESOLVERLABELKEYNAMEkey name for the label identifying the asset violation resolver	Package stream2bq stream from PubSub to BigQuery 1) assets 2) compliance states 3) violations - Triggered by: Messages in related PubSub topics - Instances: one per Big Query table - assets - compliance states - violations - Output: Streming into BigQuery tables - Cardinality: one-one, one pubsub message - one stream insert in BQ - Automatic retrying: yes - Required environment variables: - ASSETSCOLLECTIONID the name of the FireStore collection grouping all assets documents - BQ_DATASET name of the Big Query dataset hosting the table - BQ_TABLE name of the Big Query table where to insert streams - OWNERLABELKEYNAME key name for the label identifying the asset owner - VIOLATIONRESOLVERLABELKEYNAMEkey name for the label identifying the asset violation resolver
upload2gcs Package upload2gcs stores feeds as JSON files in a GCS bucket Manage file creation (with override) and deletion.	Package upload2gcs stores feeds as JSON files in a GCS bucket Manage file creation (with override) and deletion.

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