ComplianceAsCode/content

Developer Guide

• Introduction
  • Overview
  • Contributing
  • Communication Channels
• Building ComplianceAsCode
  • Fast Track
  • Installing build dependencies
  • Downloading the source code
  • Building
  • Testing
  • Installation
  • Extra Building Options
• Creating Content
  • Directory Structure/Layout
  • Profiles
  • Controls
• ComplianceAsCode Style Guide
  • Pull Requests
  • All files
  • Jinja
  • Python
  • YAML
  • Remediation
  • XML
  • Tests
  • Markup Languages
• Tools and Utilities
  • Profile Statistics and Utilities
  • Generating Controls from DISA’s XCCDF Files
  • Generating login banner regular expressions
  • Modifying rule directory content files
• Contributing with XCCDFs, OVALs and remediations
  • Contributing
  • Remediations
  • Templating
  • Applicability of content
  • Tests (ctest)
  • Tests (OCP4)
  • Contribution to infrastructure code
• Understanding the ComplianceAsCode build system
  • Introduction
  • High-Level Overview
• Legacy Notice

Testing Content Using SSG Test Suite

• Introduction
• Preparing a backend for testing
  • Libvirt backend
  • Container backends
• Test scenarios
  • Scenarios format
  • Example of adding new test scenarios
  • Sharing code among test scenarios
• Running tests
  • Argument summary
  • Rule-based testing
  • Profile-based testing
  • Combined testing mode
• Analysis of results
• Known issues

Graphs

• Introduction
• content/*/benchmarks
• content/build-scripts
• content/controls
• content/docs
• content/products
• content/*/rules
• content/shared
• content/tests
• content/utils

Jinja Macros Reference

• Ansible
• Bash
• General
• High Level
• Kubernetes
• OVAL

Templates Reference

• Available Templates
• Creating Templates
• Filters

Python Modules Reference

• ssg package
• tests package
• tests.ssg_test_suite package
• utils package

Release Tools Documentation

• How to Perform An Upstream Release (GitHub)
  • Stabilization Phase
  • Before the Release
  • Check Phase
  • Build and Release Phase
  • Release
  • Clean Up and Bump Version
  • Announce It!
• How to Perform A Downstream Build (Fedora, COPR)
  • Fedora Builds

Indices and tables

• Index

• Module Index

• Search Page