cronjob-primitive

command
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 30, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

README

CronJob Primitive Example

This example demonstrates the usage of the cronjob primitive within the operator component framework. It shows how to manage a Kubernetes CronJob as a component of a larger application, utilizing features like:

  • Base Construction: Initializing a CronJob with a schedule, job template, and containers.
  • Feature Mutations: Applying conditional changes (tracing env vars, metrics annotations, version-based image updates) using the Mutator.
  • Suspension: Suspending the CronJob by setting spec.suspend = true.
  • Data Extraction: Harvesting information from the reconciled resource.

Directory Structure

  • app/: Defines the mock ExampleApp CRD and the controller that uses the component framework.
  • features/: Contains modular feature definitions:
    • mutations.go: tracing env vars, metrics annotations, and version-based image updates.
  • resources/: Contains the central NewCronJobResource factory that assembles all features using the cronjob.Builder.
  • main.go: A standalone entry point that demonstrates a reconciliation loop using a fake client.

Running the Example

You can run this example directly using go run:

go run examples/cronjob-primitive/main.go

This will:

  1. Initialize a fake Kubernetes client.
  2. Create an ExampleApp owner object.
  3. Reconcile the ExampleApp components through multiple spec changes.
  4. Print the resulting status conditions.

Documentation

Overview

Package main is the entry point for the cronjob primitive example.

Directories

Path Synopsis
Package app provides a sample controller using the cronjob primitive.
Package app provides a sample controller using the cronjob primitive.
Package features contains example CronJob mutation features.
Package features contains example CronJob mutation features.
Package resources provides resource implementations for the cronjob primitive example.
Package resources provides resource implementations for the cronjob primitive example.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL