Cribl Ansible Collections

📦 Latest Release

Current Version: v4.18.2 | Released: | Download

Generated from Cribl API Spec 4.18.2

---

Module Generator

Auto-generate all Ansible modules from Cribl's OpenAPI specification:

# Generate all modules (imperative + declarative)
python scripts/generate_modules.py --declarative

# Clean and regenerate
python scripts/generate_modules.py --clean

# Specific collection only
python scripts/generate_modules.py --product core

# Use custom OpenAPI spec
python scripts/generate_modules.py --spec path/to/cribl-api.yml

Features:

• Automatic parameter extraction from OpenAPI schemas
• Smart categorization (routes to correct product collection)
• Documentation generation (DOCUMENTATION, EXAMPLES, RETURN blocks)
• Type conversion (OpenAPI types → Ansible types)
• Built-in error handling and authentication

Documentation: See docs/GENERATOR.md for advanced usage.

---

Security

SSL Certificates

# Development (self-signed certs)
validate_certs: false

# Production (valid certs)
validate_certs: true

Secure Credentials with Ansible Vault

# Create encrypted vault
ansible-vault create vault.yml

# Add your credentials
cribl_username: admin
cribl_password: your-secure-password
cribl_token: your-api-token

# Use in playbooks
ansible-playbook playbook.yml -e @vault.yml --ask-vault-pass

Environment Variables

vars:
  cribl_url: "{{ lookup('env', 'CRIBL_URL') }}"
  cribl_token: "{{ lookup('env', 'CRIBL_TOKEN') }}"

---

Documentation

• Auto-Generation Guide - How automatic CRUD detection works
• Declarative Modules Guide - Complete guide to state-based management
• Testing Guide - Docker tests, unit tests, integration tests
• Generator Guide - Module generation and customization
• API Reference - All modules and parameters
• Examples - Real-world playbook examples
• Contributing - How to contribute

---

Project Structure

.
├── scripts/
│   ├── generate_modules.py              # CLI entry point
│   └── generator/                       # Modular generator
│       ├── openapi_parser.py            # Parse OpenAPI specs
│       ├── module_generator.py          # Generate imperative modules
│       ├── declarative_generator.py     # Generate declarative modules
│       ├── collection_manager.py        # Manage collection structure
│       └── templates.py                 # Code templates
├── schemas/
│   └── cribl-apidocs-4.15.0.yml        # OpenAPI specification
├── build/
│   └── ansible_collections/cribl/       # Generated collections
│       ├── core/                        # 276 modules
│       ├── stream/                      # 127 modules
│       ├── edge/                        # 19 modules
│       ├── search/                      # 80 modules
│       └── lake/                        # 11 modules
├── docs/                                # Documentation
├── tests/                               # Test suite
│   ├── docker/                          # Docker integration tests
│   ├── unit/                            # Unit tests
│   └── integration/                     # Integration tests
├── Makefile                             # Development commands
└── README.md                            # This file

---

Requirements

• Python: 3.6 or higher
• Ansible: 2.9 or higher
• PyYAML: For OpenAPI parsing
• Docker: For integration tests (optional)
• Cribl Instance: Stream, Edge, Search, or Lake

---

Contributing

Contributions welcome! Please see CONTRIBUTING.md for:

• Code style guidelines
• Testing requirements
• Pull request process
• Development setup

---

Support

• Documentation: Cribl Docs
• API Reference: Cribl API
• Issues: GitHub Issues
• Cribl Community: Slack

---

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Roadmap

• 513 imperative modules (all Cribl API endpoints)
• Automatic CRUD detection and declarative module generation
• 49 auto-generated declarative modules across all collections
• Auto-generated unit tests and integration playbooks
• Docker integration testing
• Check mode and diff support
• Cribl Cloud Support
• Smart declarative functions targeting worker groups

---

Acknowledgments

• Built for the Cribl Community
• Uses Cribl's OpenAPI Specification
• Inspired by Infrastructure as Code best practices