API Reference
Packages:
kube-green.com/v1alpha1β
Package v1alpha1 contains API Schema definitions for the v1alpha1 API group
Resource Types:SleepInfoβ
SleepInfo is the Schema for the sleepinfos API
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | kube-green.com/v1alpha1 | ||||||||||||
kind string | SleepInfo | ||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of themetadata field. | ||||||||||||
spec SleepInfoSpec |
| ||||||||||||
status SleepInfoStatus |
ExcludeRefβ
(Appears on: SleepInfoSpec)
Field | Description |
---|---|
apiVersion string | ApiVersion of the kubernetes resources. Supported api version is βapps/v1β. |
kind string | Kind of the kubernetes resources of the specific version. Supported kind is βDeploymentβ. |
name string | Name which identify the kubernetes resource. |
SleepInfoSpecβ
(Appears on: SleepInfo)
SleepInfoSpec defines the desired state of SleepInfo
Field | Description |
---|---|
weekdays string | Weekdays are in cron notation. For example, to configure a schedule from monday to friday, set it to β1-5β |
sleepAt string | Hours:Minutes Accept cron schedule for both hour and minute. For example, :/2 is set to configure a run every even minute. |
wakeUpAt string | (Optional) Hours:Minutes Accept cron schedule for both hour and minute. For example, :/2 is set to configure a run every even minute. It is not required. |
timeZone string | (Optional) Time zone to set the schedule, in IANA time zone identifier. It is not required, default to UTC. For example, for the Italy time zone set Europe/Rome. |
excludeRef []ExcludeRef | (Optional) ExcludeRef define the resource to exclude from the sleep. |
suspendCronJobs bool | (Optional) If SuspendCronjobs is set to true, on sleep the cronjobs of the namespace will be suspended. |
SleepInfoStatusβ
(Appears on: SleepInfo)
SleepInfoStatus defines the observed state of SleepInfo
Field | Description |
---|---|
lastScheduleTime Kubernetes meta/v1.Time | (Optional) Information when was the last time the run was successfully scheduled. |
operation string | (Optional) The operation type handled in last schedule. SLEEP or WAKE_UP are the possibilities |
Generated with gen-crd-api-reference-docs
on git commit feb7bf1
.