Warning
Disclaimer: this repository is in Preview and the structure might change in the future.
👋 Hello and welcome! This repository is the central hub for a wide array of content related to the Google SecOps marketplace. Whether you're looking to connect Google SecOps with other security tools, explore practical use-cases, or leverage powerful development packages, you've come to the right place.
Our goal is to provide you with all the resources you need to effectively use, develop, and contribute to the Google SecOps ecosystem.
To help you find your way around and make the most of what's available, we've structured
our documentation into several key areas.
Think of this section as your compass,
pointing you to detailed information, guides, and resources. Most of our in-depth
documentation resides in the docs/ directory, with specific tools and
packages also having their own detailed README files.
New to the repository or Google SecOps integrations? Start here!
- Understanding This Repository: You're reading it! This file provides a high-level overview.
- Core Concepts: Learn about the fundamental principles behind Google SecOps integrations.
- Installation & Setup: General setup instructions for working with this repository's content.
Discover how to connect Google SecOps with a multitude of other security products and services.
- Browse Available Integrations: Explore the
integrations/directory to see the integrations we offer. Each integration typically has its ownREADME.mdordefinition.yamlproviding specific details. - Marketplace Integration Development Guide: Understand how to work with marketplace integrations.
- How-To Guides & Examples:
- Running & Testing Integrations: Practical guides on configuring and using the integrations.
- Code Examples: Snippets and scenarios showcasing integration capabilities.
-
*Building Your Own Integration **: Comprehensive instructions and guidelines on how to develop, build, and package your custom integrations.
Ready to dive deeper, fix a bug, or contribute your own enhancements?
- Development Environment Setup: How to set up your local environment for development.
- Coding Standards & Style:
- Code Style Guide: Our conventions for writing clean, consistent, and maintainable code.
- Linters & Formatters: Information on the tools we use to enforce code quality (e.g., Ruff, Mypy).
- Testing Your Changes:
- Running Tests: How to execute unit tests and black-box tests.
- Unit Tests: Learn about component-level testing.
- Black Box Testing Infrastructure: Understand our end-to-end testing framework.
- Contributing to the Project: The complete guide on how to contribute, including reporting bugs, suggesting features, and submitting pull requests.
Explore the shared libraries and utilities designed to make your development process smoother.
- Shared Code Packages (
packages/): Discover reusable libraries likeTIPCommonandEnvironmentCommon. For detailed information, see thepackages/README.md. - Developer Utilities (
tools/): Find scripts and command-line tools to assist with common development and operational tasks. For more details, see thetools/README.md.- Integration Zipper: A utility to package integration versions. More details in its dedicated README.
- Marketplace CLI Tool (
mp):packages/mp/README.md- Your powerhouse for building, testing, and ensuring the quality of integrations. (Also linked frompackages/README.md).
Important information regarding licensing and community conduct.
- Licensing Information: LICENSE - Understand the terms under which the content in this repository is made available.
- Code of Conduct:
docs/code_of_conduct.md- Our commitment to a welcoming, respectful, and inclusive community. - Security Policy: (Future link:
SECURITY.mdordocs/security.md) - How to report security vulnerabilities.
We continuously strive to improve this repository and its documentation. If you have suggestions or find something unclear, please don't hesitate to open an issue or contribute!