API Reference¶
Complete API reference documentation for the Bindy operator.
Custom Resource Definitions (CRDs)¶
Detailed API documentation for all Custom Resources:
- Bind9Cluster API - DNS cluster within a single Kubernetes cluster
- ClusterBind9Provider API - Provider reference for cross-cluster operations
- Bind9Instance API - Individual BIND9 DNS server instances
- DNSZone API - DNS zone management
- DNS Records API - DNS record types (A, AAAA, CNAME, MX, TXT, NS, SRV, CAA)
Full CRD Specifications¶
Auto-generated from Rust source code:
- Complete API Specification - Full CRD schemas with all fields and validation
Operator API¶
For information about the Rust operator internals:
- Rustdoc API Documentation - Complete Rust API documentation
Status Conditions¶
All Custom Resources report status using Kubernetes standard conditions:
- Status Conditions Reference - Condition types, reasons, and meanings
Examples¶
Practical examples of using the APIs:
- Examples Overview - Collection of example manifests
- Simple Setup - Basic single-region setup
- Production Setup - Multi-region HA setup
- Multi-Region Setup - Cross-cluster DNS
Specifications by Resource¶
Bind9Cluster¶
See Bind9Cluster Spec for detailed field documentation.
Bind9Instance¶
See Bind9Instance Spec for detailed field documentation.
DNSZone¶
See DNSZone Spec for detailed field documentation.
DNS Records¶
See DNS Records Spec for all supported record types.
API Versioning¶
Current API version: v1beta1
Beta API
The API is currently in beta (v1beta1). Breaking changes may occur, but will be documented in the Changelog with migration guides.
Validation¶
All CRDs include OpenAPI v3 validation schemas. Invalid resources will be rejected by the Kubernetes API server before reaching the operator.
Related Documentation¶
- Basic Concepts - Understanding the resource model
- User Guide - Practical usage patterns
- Troubleshooting - Common API issues