Giter VIP home page Giter VIP logo

ingestion-scripts's Introduction

Chronicle 3p Ingestion Scripts

Deploying the Cloud Function

Setting up the directory

Create a new directory for the cloud function deployment and add the following files into that directory:

  1. Contents of the desired platform (i.e. OneLogin_User)
  2. common directory

Setting the required runtime environment variables

Edit the .env.yml file to populate all the required environment variables. Information related to all the environment variables can be found in the README.md file.

Common runtime environment variables

Following is the table listing all the Chronicle related runtime environment variables that must be configured for all the ingestion scripts.

Variable Description Required Default Secret
POLL_INTERVAL Poll interval Yes - No
: : for the cloud : : : :
: : function. : : : :
CHRONICLE_CUSTOMER_ID Chronicle Yes - No
: : customer Id. : : : :
CHRONICLE_REGION Chronicle Yes us No
: : region. : : : :
CHRONICLE_SERVICE_ACCOUNT Contents of Yes - Yes
: : the Chronicle : : : :
: : ServiceAccount : : : :
: : JSON file. : : : :

Using secrets

Environment variables marked as Secret must be configured as secrets on Google Secret Manager. Refer this page to learn how to create secrets.

Once the secrets are created on Secret Manager, use the secret's resource name as the value for environment variables. For example:

 CHRONICLE_SERVICE_ACCOUNT: projects/{project_id}/secrets/{secret_id}/versions/{version_id}

Configuring the namespace

The namespace that the Chronicle logs are ingested into can be configured by setting the CHRONICLE_NAMESPACE environment variable.

Deploying the cloud function

Execute the following command from inside the previously created directory to deploy the cloud function.

gcloud functions deploy <FUNCTION NAME> --entry-point main --trigger-http --runtime python39 --env-vars-file .env.yml

Support

These scripts are provided as examples and are not officially supported. We welcome feedback on how we can improve them. To submit feedback, go to the Chronicle Ingestion Script documentation and click "Send Feedback".

Resources

ingestion-scripts's People

Contributors

drainbamage33 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.