Hikaru: Usage and Reference

Release: 1.1.0

Contents:

• Introduction
• Installation and Quickstart
  • Installing
  • Quickstart
• Installation
  • Package Overview
  • Things to keep in mind
  • Deprecations
  • Package versioning
• Key Functions
  • load_full_yaml()
  • get_yaml()
  • get_json()
  • from_json()
  • get_clean_dict()
  • from_dict()
  • get_python_source()
  • process_api_version()
  • get_processors()
  • get_default_release()
  • set_default_release()
  • set_global_default_release()
  • get_version_kind_class()
  • register_version_kind_class()
  • rollback_cm()
  • register_crd_class()
  • get_crd_schema()
• Kubernetes API Releases and Versions
  • The Common Use Cases
  • Support for Kubernetes Releases and Versions
  • Importing
• The HikaruBase class
  • from_yaml()
  • get_empty_instance()
  • as_python_source()
  • Support for ==
  • dup()
  • find_by_name()
  • get_type_warnings()
  • diff()
  • object_at_path()
  • repopulate_catalog()
• The HikaruDocumentBase class
  • Method responses and the Response object
• Using Hikaru with Kubernetes
  • Hikaru CRUD methods
  • create()
  • read()
  • update()
  • delete()
  • Hikaru low-level methods
• Watchers: Monitoring Kubernetes Activity
  • Intro
  • The watch module
  • A simple example
  • Working with Watchers
  • Streaming multiple event types: the MultiplexingWatcher
• Hikaru Application
  • Application Basics
  • Digging Deeper
  • Other Operations
• Advanced Hikaru Topics
  • Defining Your Own Classes
  • Hikaru CRD Support
  • Hikaru Application
• Patterns and Recipes
  • Tweaking an existing Kubernetes config
  • Finding out the version of a loaded document
  • Shutting up the linter
  • Avoiding the version change trap
  • Mass migrating YAML to Hikaru
  • Checking types on a Hikaru model
  • Checking resource limits on a config
• Issues, Changes and Limitations
  • Python reserved words
  • Workarounds for JSONSchemProps
  • Long-ish run times for formatting Python code
  • Limited correctness checking
  • ruamel.yaml vs PyYAML
• Reference
  • Objects returned when querying Hikaru itself
  • Hikaru modelling base classes
  • Hikaru Application classes
  • Hikaru Watchers
  • Hikaru functions
• Why ‘Hikaru’?

Indices and tables

• Search Page

• Index

• Module Index

K8s V1.28 v1 Documents Doc

1.28v1 ref docs

• Autodoc for K8s Rel 1.28 v1 document classes

K8s V1.27 v1 Documents Doc

1.27v1 ref docs

• Autodoc for K8s Rel 1.27 v1 document classes

K8s V1.26 v1 Documents Doc

1.26v1 ref docs

• Autodoc for K8s Rel 1.26 v1 document classes

K8s V1.25 v1 Documents Doc

1.25v1 ref docs

• Autodoc for K8s Rel 1.25 v1 document classes

K8s V1.24 v1 Documents Doc

1.24v1 ref docs

• Autodoc for K8s Rel 1.24 v1 document classes

K8s V1.23 v1 Documents Doc

1.23v1 ref docs

• Autodoc for K8s Rel 1.23 v1 document classes