Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sparkfabrik/terraform-kubernetes-application-sleep-cycles

Terraform module to manage application sleep cycles in Kubernetes.
https://github.com/sparkfabrik/terraform-kubernetes-application-sleep-cycles

iac infrastructure-as-code kubernetes terraform terraform-module

Last synced: 21 days ago
JSON representation

Terraform module to manage application sleep cycles in Kubernetes.

Host: GitHub
URL: https://github.com/sparkfabrik/terraform-kubernetes-application-sleep-cycles
Owner: sparkfabrik
License: gpl-3.0
Created: 2024-10-30T10:46:57.000Z (2 months ago)
Default Branch: main
Last Pushed: 2024-12-05T16:31:12.000Z (about 1 month ago)
Last Synced: 2024-12-05T17:23:01.899Z (about 1 month ago)
Topics: iac, infrastructure-as-code, kubernetes, terraform, terraform-module
Language: HCL
Homepage:
Size: 35.2 KB
Stars: 0
Watchers: 6
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # Terraform Kubernetes Application Sleep Cycles

This is a Terraform module to install a cron job on a Kubernetes cluster that uses the labels of application instances to perform a scale down to zero during predefined periods, thus reducing resource consumption, and then automatically restores the applications by scaling up at the end of the idle period.

## Providers

| Name | Version |

|------|---------|

|  [kubernetes](#provider\_kubernetes) | >= 2.26 |

## Requirements

| Name | Version |

|------|---------|

|  [terraform](#requirement\_terraform) | >= 1 |

|  [kubernetes](#requirement\_kubernetes) | >= 2.26 |

## Inputs

| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

|  [additional\_protected\_namespaces](#input\_additional\_protected\_namespaces) | List of additional namespaces where the controller should not manage the scale of deployments. | `list(string)` | `[]` | no |

|  [cluster\_role\_binding\_name](#input\_cluster\_role\_binding\_name) | Name of the cluster role binding. | `string` | `"custom:application-sleep-cycles:controller"` | no |

|  [cluster\_role\_name\_prefix](#input\_cluster\_role\_name\_prefix) | Name of the cluster role. | `string` | `"custom:application-sleep-cycles:controller"` | no |

|  [configmap\_name\_prefix](#input\_configmap\_name\_prefix) | Name prefix for the Config Maps. | `string` | `"application-sleep-cycles-config"` | no |

|  [create\_namespace](#input\_create\_namespace) | Create namespace. If false, the namespace must be created before using this module. | `bool` | `true` | no |

|  [cronjob\_timezone](#input\_cronjob\_timezone) | Timezone to use for the cron jobs. | `string` | `"Europe/Rome"` | no |

|  [deployments\_label\_selector](#input\_deployments\_label\_selector) | Label selector for the Deployments to be scaled during working-hours. | `map(string)` | 
{
  "sparkfabrik.com/application-availability": "working-hours"
} | no |

|  [k8s\_additional\_labels](#input\_k8s\_additional\_labels) | Set of additional labels to apply to all resources. | `map(string)` | `{}` | no |

|  [k8s\_labels](#input\_k8s\_labels) | Set of labels to apply to all resources. | `map(string)` | {
  "managed-by": "terraform",
  "scope": "finops"
} | no |

|  [managed\_namespaces](#input\_managed\_namespaces) | List of namespaces where the controller should manage the scale of deployments. The namespaces defined here will be merged with the namespaces fetched by the `managed_namespaces_label_selector` variable. | `list(string)` | `[]` | no |

|  [managed\_namespaces\_all\_label\_selector](#input\_managed\_namespaces\_all\_label\_selector) | Label selector for all resources in the namespaces where the controller should manage the scale of deployments. The namespace must have `managed_namespaces_label_selector` set. | `map(string)` | {
  "sparkfabrik.com/application-availability": "working-hours"
} | no |

|  [managed\_namespaces\_label\_selector](#input\_managed\_namespaces\_label\_selector) | Label selector for the namespaces where the controller should manage the scale of deployments. The namespaces fetched by this selector will be merged with the `managed_namespaces` variable. **WARNING:** remember that if the labels specified here are added to new namespaces, the module will send the Terraform state into drift, as the list of namespaces is retrieved dynamically. You must then re-apply your Terraform configuration to fix the drift.. | `map(string)` | {
  "sparkfabrik.com/application-sleep-cycles": "enabled"
} | no |

|  [namespace](#input\_namespace) | Namespace to create resources. | `string` | `"application-sleep-cycles"` | no |

|  [protected\_namespaces](#input\_protected\_namespaces) | List of namespaces where the controller should not manage the scale of deployments. Use additional\_protected\_namespaces to add custom protected namespaces. | `list(string)` | [
  "kube-node-lease",
  "kube-public",
  "kube-system",
  "gmp-system",
  "gmp-public"
] | no |

|  [service\_account\_name](#input\_service\_account\_name) | Name of the service account. | `string` | `"application-sleep-cycles-sa"` | no |

|  [statefulsets\_label\_selector](#input\_statefulsets\_label\_selector) | Label selector for the Statefulsets to be scaled during working-hours. | `map(string)` | {
  "sparkfabrik.com/application-availability": "working-hours"
} | no |

|  [working\_hours\_docker\_image](#input\_working\_hours\_docker\_image) | Docker image to use for the working hours CronJobs. | `string` | `"bitnami/kubectl:1.29"` | no |

|  [working\_hours\_resource\_prefix](#input\_working\_hours\_resource\_prefix) | Prefix for the working hours resources. | `string` | `"application-sleep-cycles-working-hours"` | no |

|  [working\_hours\_scale\_down\_schedule](#input\_working\_hours\_scale\_down\_schedule) | Cron schedule to scale down the Deployments. Remember that this is relative to the timezone defined in the `cronjob_timezone` variable. | `string` | `"0 20 * * *"` | no |

|  [working\_hours\_scale\_up\_schedule](#input\_working\_hours\_scale\_up\_schedule) | Cron schedule to scale up the Deployments. Remember that this is relative to the timezone defined in the `cronjob_timezone` variable. | `string` | `"30 7 * * 1-5"` | no |

|  [working\_hours\_suspend](#input\_working\_hours\_suspend) | Suspend the CronJob. | `bool` | `false` | no |

## Outputs

| Name | Description |

|------|-------------|

|  [k8s\_full\_labels](#output\_k8s\_full\_labels) | Full set of labels applied to all resources. |

|  [namespace](#output\_namespace) | Namespace where the descheduler is installed. |

## Resources

| Name | Type |

|------|------|

| [kubernetes_cluster_role_binding_v1.cluster_scoped](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/cluster_role_binding_v1) | resource |

| [kubernetes_cluster_role_v1.cluster_scoped](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/cluster_role_v1) | resource |

| [kubernetes_config_map_v1.app](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/config_map_v1) | resource |

| [kubernetes_config_map_v1.app_env](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/config_map_v1) | resource |

| [kubernetes_manifest.scale_down](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/manifest) | resource |

| [kubernetes_manifest.scale_up](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/manifest) | resource |

| [kubernetes_namespace_v1.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/namespace_v1) | resource |

| [kubernetes_secret_v1.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/secret_v1) | resource |

| [kubernetes_service_account_v1.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/service_account_v1) | resource |

| [kubernetes_namespace_v1.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/data-sources/namespace_v1) | data source |

| [kubernetes_resources.managed_namespaces_by_labels](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/data-sources/resources) | data source |

## Modules

No modules.