API Reference#

Packages#

ClusterResourceSupervisor is the Schema for the resourcesupervisors API

Field	Description	Default	Validation
`apiVersion` string	`hibernation.stakater.com/v1beta1`
`kind` string	`ClusterResourceSupervisor`
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` ClusterResourceSupervisorSpec
`status` ClusterResourceSupervisorStatus

ClusterResourceSupervisorSpec defines the desired state of ClusterResourceSupervisor

Field	Description	Validation
`schedule` Hibernation		Required: {}
`namespaces` Namespaces	Namespaces is a list of namespaces to which the schedule will be applied	Optional: {}
`argocd` ArgoCDHibernation	ArgoCD contains details about ArgoCD to which the schedule will be applied

ClusterResourceSupervisorStatus defines the observed state of ClusterResourceSupervisor

Field	Description	Validation
`nextReconcileTime` Time	NextReconcileTime contains the next time at which the namespace resources will sleep or wake up
`currentStatus` Status	CurrentStatus shows the state the tenant's resources	Enum: [sleeping running error]
`sleepingNamespaces` SleepingNamespace array	SleepingResources contains the previous states for each of the deployments currently scaled down
`watchedNamespaces` string array	WatchedNamespaces contains the namespaces this supervisor may hibernate
`ignoreNamespaces` string array	IgnoreNamespaces contains the namespaces this supervisor was asked to hibernate but may not
`conditions` Condition array	Conditions holds Ready, which says whether the last pass did what the schedule asked and if not why. An Event expires and nothing queries it, so without it a failed pass or an unparseable cron would leave no trace on the resource at all.	Optional: {}

ResourceSupervisor is the Schema for the resourcesupervisors API

Field	Description	Default	Validation
`apiVersion` string	`hibernation.stakater.com/v1beta1`
`kind` string	`ResourceSupervisor`
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` ResourceSupervisorSpec
`status` ResourceSupervisorStatus

ResourceSupervisorSpec defines the desired state of ResourceSupervisor API

Field	Description	Default	Validation
`schedule` Hibernation			Required: {}

ResourceSupervisorStatus defines the observed state of ResourceSupervisor

Field	Description	Validation
`nextReconcileTime` Time	NextReconcileTime contains the next time at which the namespace resources will sleep or wake up
`currentStatus` Status	CurrentStatus shows the state the tenant's resources	Enum: [sleeping running error]
`sleepingNamespaces` SleepingNamespace array	SleepingResources contains the previous states for each of the deployments currently scaled down
`watchedNamespaces` string array	WatchedNamespaces contains the namespaces this supervisor may hibernate
`ignoreNamespaces` string array	IgnoreNamespaces contains the namespaces this supervisor was asked to hibernate but may not
`conditions` Condition array	Conditions holds Ready, which says whether the last pass did what the schedule asked and if not why. An Event expires and nothing queries it, so without it a failed pass or an unparseable cron would leave no trace on the resource at all.	Optional: {}