API Reference
API Reference
Packages
kubecloudscaler.cloud/v1alpha1
Package v1alpha1 contains API Schema definitions for the k8s v1alpha1 API group
Resource Types
FixedPeriod
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
startTime string | Pattern: ^\d\{4\}-(0?[1-9]|1[0,1,2])-(0?[1-9]|[12][0-9]|3[01]) ([0-1]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]$ | ||
endTime string | Pattern: ^\d\{4\}-(0?[1-9]|1[0,1,2])-(0?[1-9]|[12][0-9]|3[01]) ([0-1]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]$ | ||
timezone string | |||
once boolean | Run once at StartTime | ||
gracePeriod string | Grace period in seconds for deployments before scaling down | Pattern: ^\d*s$ | |
reverse boolean | Reverse the period |
Gcp
Gcp is the Schema for the scalers API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | kubecloudscaler.cloud/v1alpha1 | ||
kind string | Gcp | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec GcpSpec | |||
status ScalerStatus |
GcpSpec
GcpSpec defines the desired state of Scaler
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
dryRun boolean | dry-run mode | ||
periods ScalerPeriod array | Time period to scale |
K8s
Scaler is the Schema for the scalers API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | kubecloudscaler.cloud/v1alpha1 | ||
kind string | K8s | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec K8sSpec | |||
status ScalerStatus |
K8sSpec
ScalerSpec defines the desired state of Scaler
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
dryRun boolean | dry-run mode | ||
periods ScalerPeriod array | Time period to scale | ||
namespaces string array | Resources Namespaces | ||
excludeNamespaces string array | Exclude namespaces from downscaling | ||
forceExcludeSystemNamespaces boolean | Force exclude system namespaces | ||
resources string array | Resources | ||
excludeResources string array | Exclude resources from downscaling | ||
labelSelector LabelSelector | Labels selectors | ||
deploymentTimeAnnotation string | Deployment time annotation | ||
disableEvents boolean | Disable events |
RecurringPeriod
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
days string array | |||
startTime string | Pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$ | ||
endTime string | Pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$ | ||
timezone string | |||
once boolean | Run once at StartTime | ||
gracePeriod string | Pattern: ^\d*s$ | ||
reverse boolean | Reverse the period |
ScalerPeriod
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
type string | Enum: [down up] | ||
time TimePeriod | |||
minReplicas integer | Minimum replicas | ||
maxReplicas integer | Maximum replicas |
ScalerStatus
ScalerStatus defines the observed state of Scaler
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
currentPeriod ScalerStatusPeriod | |||
comments string |
ScalerStatusFailed
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
kind string | |||
name string | |||
reason string |
ScalerStatusPeriod
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
spec RecurringPeriod | |||
specSHA string | |||
success ScalerStatusSuccess array | |||
failed ScalerStatusFailed array |
ScalerStatusSuccess
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
kind string | |||
name string |
TimePeriod
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
recurring RecurringPeriod | |||
fixed FixedPeriod |