README
¶
Furiko
Furiko is a cloud-native, enterprise-level cron and adhoc job platform for Kubernetes.
The main website for documentation and updates is hosted at https://furiko.io.
Introduction
Furiko is a Kubernetes-native operator for managing, scheduling and executing scheduled and adhoc jobs and workflows. It aims to be a general-purpose job platform that supports a diverse range of use cases, including cron jobs, batch processing, workflow automation, etc.
Furiko is built from the beginning to support enterprise-level use cases and running self-hosted in a private Kubernetes cluster, supporting users across a large organization.
Some use cases that are perfect for Furiko include:
- Cron-based scheduling massive amounts of periodic jobs per day in a large organization
- Scheduling some jobs to run once at a later time, with a set of specific inputs
- Starting multiple jobs to execute one after another, once the previous job has finished
- Event-driven, offline/asynchronous job processing via webhooks
- Building a platform to automate business operations via form-based inputs (with Furiko as the job engine)
Contributing
See CONTRIBUTING.md.
License
NOTE: Although started within the company, Furiko is not an official Shopee project or product.
Furiko is licensed under the Apache License, Version 2.0.
Logo is designed by Duan Weiwei, and is distributed under CC-BY 4.0.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
apis
|
|
|
config/v1alpha1
Package v1 contains API Schema definitions for the config v1 API group +kubebuilder:object:generate=true +groupName=config.furiko.io
|
Package v1 contains API Schema definitions for the config v1 API group +kubebuilder:object:generate=true +groupName=config.furiko.io |
|
execution/v1alpha1
Package v1alpha1 contains API Schema definitions for the execution v1alpha1 API group +kubebuilder:object:generate=true +groupName=execution.furiko.io
|
Package v1alpha1 contains API Schema definitions for the execution v1alpha1 API group +kubebuilder:object:generate=true +groupName=execution.furiko.io |
|
cmd
|
|
|
pkg
|
|
|
config
Package config contains static configuration for the project.
|
Package config contains static configuration for the project. |
|
execution/mutation
nolint:lll
|
nolint:lll |
|
execution/validation
nolint:lll
|
nolint:lll |
|
generated/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
generated/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
generated/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
generated/clientset/versioned/typed/execution/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
generated/clientset/versioned/typed/execution/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
runtime/testing
Package testing contains testing utilities for controller runtimes.
|
Package testing contains testing utilities for controller runtimes. |
|
utils/eventhandler
Package eventhandler contains utilities to perform type assertions on events returned from resource event handlers.
|
Package eventhandler contains utilities to perform type assertions on events returned from resource event handlers. |