Advanced Hikaru Topics

Contents:

• Defining Your Own Classes
  • First Things First
  • How to Register Your Class
  • Use Case: Adding Only Methods to Hikaru Classes
  • Use Case: Adding Instance Attributes That Aren’t Passed In
  • Use Case: Adding Instance Attributes That Are Passed In
  • Making a Class For a New Document Type
• Hikaru CRD Support
  • Quick Example
    • The resource
    • Defining the CRD
    • Creating Instances
    • Watching Activity on the CRD
    • Other CRUD methods
  • Creating a CRD
    • Base classes
    • Required attribute: apiVersion: str = "<group>/<version>"
    • Required attribute: kind: str = "CRDName"
    • Required attribute: metadata: ObjectMeta
    • Decorated with dataclass
    • Other data
    • Supported type annotations
    • Specifying more details with field()
    • Good practices
  • Defining the CRD to Kubernetes
    • The basics
    • Defining namespaced CRDs
    • Places you might go wrong
  • Limitations
    • Recursive definitions
    • dicts are str:str only
    • Can’t automatically create Hikaru classes from existing CRDs
    • Limits on the modifiers available to fine-tune attribute definitions
    • No Unions
    • No list operations
    • No ObjectMeta-less reads
    • No direct support for datetime attributes
• Hikaru Application
  • Application Basics
    • Creating an Application Class
    • CRUD Operations
    • Monitoring Operations
  • Digging Deeper
    • Labels and Annotations
    • Modeling Constraints
    • Persistence Forms
    • Factory Methods for Canonical Forms and Instance Customization
  • Other Operations