Kopf: Kubernetes Operators Framework

First steps:

• Installation

Tutorial:

• Concepts
• Sample Problem
  • Problem Statement
  • Problem Solution
• Environment Setup
• Custom Resources
  • Custom Resource Definition
  • Custom Resource Objects
• Starting the operator
• Creating the objects
• Updating the objects
• Diffing the fields
  • Old & New
  • Diffs
• Cascaded deletion
• Cleanup

Resource handling:

• Handlers
  • Events & Causes
  • Registering
  • Event-watching handlers
  • State-changing handlers
  • Resuming handlers
  • Field handlers
  • Sub-handlers
• Daemons
  • Spawning
  • Termination
  • Timeouts
  • Safe sleep
  • Postponing
  • Restarting
  • Deletion prevention
  • Resource fields access
  • Results delivery
  • Error handling
  • Filtering
  • System resources
• Timers
  • Intervals
  • Sharpness
  • Idling
  • Postponing
  • Combined timing
  • Errors in timers
  • Results delivery
  • Filtering
  • System resources
• Arguments
  • Forward compatibility kwargs
  • Retrying and timing
  • Parametrization
  • Operator configuration
  • Resource-related kwargs
  • Resource-watching kwargs
  • Resource-changing kwargs
  • Resource daemon kwargs
  • Resource admission kwargs
• Async/Await
• Loading and importing
• Resource specification
• Filtering
  • Metadata filters
  • Field filters
  • Change filters
  • Value callbacks
  • Callback filters
  • Callback helpers
  • Stealth mode
• Results delivery
• Error handling
  • Temporary errors
  • Permanent errors
  • Regular errors
  • Timeouts
  • Retries
  • Backoff
• Scopes
  • Namespaces
  • Cluster-wide
• In-memory containers
  • Resource memos
  • Operator memos
  • Custom memo classes
  • Limitations
• In-memory indexing
  • Index declaration
  • Index structure
  • Index content
  • Recipes
  • Conditional indexing
  • Errors in indexing
  • Kwargs safety
  • Performance
  • Guarantees
  • Limitations
• Admission control
  • Dependencies
  • Validation handlers
  • Mutation handlers
  • Handler options
  • In-memory containers
  • Admission warnings
  • Admission errors
  • Webhook management
  • Servers and tunnels
  • Authenticate apiservers
  • Debugging with SSL
  • Custom servers/tunnels
  • System resource cleanup

Operator handling:

• Startup
• Shutdown
• Health-checks
  • Liveness endpoints
  • Kubernetes probing
  • Probe handlers
• Authentication
  • Custom authentication
  • Piggybacking
  • Credentials lifecycle
• Configuration
  • Startup configuration
  • Logging formats and levels
  • Logging events
  • Synchronous handlers
  • Networking timeouts
  • Finalizers
  • Handling progress
  • Change detection
  • Storage transition
  • Retrying of API errors
  • Throttling of unexpected errors
• Peering
  • Priorities
  • Scopes
  • Custom peering
  • Standalone mode
  • Automatic peering
  • Multi-pod operators
  • Stealth keep-alive
• Command-line options
  • Scripting options
  • Logging options
  • Scope options
  • Probing options
  • Peering options
  • Development mode

Toolkits:

• Events
  • Handled objects
  • Other objects
  • Events for events
• Hierarchies
  • Labels
  • Nested labels
  • Owner references
  • Names
  • Namespaces
  • Adopting
  • 3rd-party libraries
• Operator testing
  • Background runner
• Embedding
  • Manual execution
  • Manual orchestration
  • Custom event loops
  • Multiple operators

Recipes:

• Deployment
  • Docker image
  • Cluster deployment
  • RBAC
• Continuity
  • Persistence
  • Restarts
  • Downtime
• Idempotence
• Reconciliation
  • Event-driven reactions
  • Regularly scheduled timers
  • Permanently running daemons
  • What to use when?
• Tips & Tricks
  • Excluding handlers forever
• Troubleshooting
  • kubectl freezes on object deletion

Developer Manual:

• Minikube
• Contributing
  • Git workflow
  • Git conventions
  • DCO sign-off
  • Code style
  • Tests
  • Reviews
• Architecture
  • Layered layout
• kopf package
  • register()
  • execute()
  • daemon()
  • timer()
  • index()
  • configure()
  • LogFormat
  • login_via_pykube()
  • login_via_client()
  • login_with_kubeconfig()
  • login_with_service_account()
  • LoginError
  • ConnectionInfo
  • event()
  • info()
  • warn()
  • exception()
  • spawn_tasks()
  • run_tasks()
  • operator()
  • run()
  • adopt()
  • label()
  • not_()
  • all_()
  • any_()
  • none_()
  • get_default_lifecycle()
  • set_default_lifecycle()
  • build_object_reference()
  • build_owner_reference()
  • append_owner_reference()
  • remove_owner_reference()
  • ErrorsMode
  • AdmissionError
  • WebhookClientConfigService
  • WebhookClientConfig
  • UserInfo
  • WebhookFn
  • WebhookServer
  • WebhookK3dServer
  • WebhookMinikubeServer
  • WebhookNgrokTunnel
  • WebhookAutoServer
  • WebhookAutoTunnel
  • PermanentError
  • TemporaryError
  • HandlerTimeoutError
  • HandlerRetriesError
  • OperatorRegistry
  • get_default_registry()
  • set_default_registry()
  • OperatorSettings
  • DiffBaseStorage
  • AnnotationsDiffBaseStorage
  • StatusDiffBaseStorage
  • MultiDiffBaseStorage
  • ProgressRecord
  • ProgressStorage
  • AnnotationsProgressStorage
  • StatusProgressStorage
  • MultiProgressStorage
  • SmartProgressStorage
  • RawEvent
  • RawBody
  • Status
  • Spec
  • Meta
  • Body
  • BodyEssence
  • ObjectReference
  • OwnerReference
  • Memo
  • Index
  • Store
  • ObjectLogger
  • LocalObjectLogger
  • Diff
  • DiffItem
  • DiffOperation
  • Reason
  • Patch
  • DaemonStoppingReason
  • Resource
  • Submodules

About Kopf:

• Vision
• Naming
• Alternatives
  • Metacontroller
  • Side8’s k8s-operator
  • CoreOS Operator SDK & Framework

Indices and tables

• Index

• Module Index

• Search Page