Skip to main content

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

FieldDescription

apiVersion
string

kube-green.com/v1alpha1

kind
string

SleepInfo
metadata

Kubernetes meta/v1.ObjectMeta

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec

SleepInfoSpec



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.

suspendDeployments

bool

(Optional)

If SuspendDeployments is set to false, on sleep the deployment of the namespace will not be suspended. By default Deployment will be suspended.

suspendStatefulsets

bool

(Optional)

If SuspendStatefulSets is set to false, on sleep the statefulset of the namespace will not be suspended. By default StatefulSet will be suspended.

patches

[]Patch

(Optional)

Patches is a list of json 6902 patches to apply to the target resources.

status

SleepInfoStatus

ExcludeRef

(Appears on: SleepInfoSpec)

FieldDescription
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 are “Deployment” and “CronJob”.

name

string

(Optional)

Name which identify the kubernetes resource.

matchLabels

map[string]string

(Optional)

MatchLabels which identify the kubernetes resource by labels

Patch

(Appears on: SleepInfoSpec)

FieldDescription
target

PatchTarget

Target is the target resource to patch.

patch

string

Patch is the json6902 patch to apply to the target resource.

PatchTarget

(Appears on: Patch)

FieldDescription
group

string

Group of the Kubernetes resources.

kind

string

Kind of the Kubernetes resources.

SleepInfoSpec

(Appears on: SleepInfo)

SleepInfoSpec defines the desired state of SleepInfo

FieldDescription
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.

suspendDeployments

bool

(Optional)

If SuspendDeployments is set to false, on sleep the deployment of the namespace will not be suspended. By default Deployment will be suspended.

suspendStatefulsets

bool

(Optional)

If SuspendStatefulSets is set to false, on sleep the statefulset of the namespace will not be suspended. By default StatefulSet will be suspended.

patches

[]Patch

(Optional)

Patches is a list of json 6902 patches to apply to the target resources.

SleepInfoStatus

(Appears on: SleepInfo)

SleepInfoStatus defines the observed state of SleepInfo

FieldDescription
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 e76e37b.