mjudeikis / terraform-castai-aks

Terraform module for conenction a AKS cluster to CAST AI

Terraform module for connecting a AKS cluster to CAST AI

Website: https://www.cast.ai

Requirements

• Terraform 0.13+

Using the module

A module to create Azure role and a service principal that can be used to connect to CAST AI

Requires castai/castai, hashicorp/azurerm, hashicorp/azuread, hashicorp/helm providers to be configured.

The required parameters can be provided manually or alternatively can be easily acquired from your AKS cluster resource or Azure RM subscription data source.

module "castai-aks-cluster" {
  source = "castai/aks/castai"

  aks_cluster_name    = var.aks_cluster_name
  aks_cluster_region  = var.aks_cluster_region
  node_resource_group = azurerm_kubernetes_cluster.example.node_resource_group
  resource_group      = azurerm_kubernetes_cluster.example.resource_group_name

  delete_nodes_on_disconnect = true

  subscription_id = data.azurerm_subscription.current.subscription_id
  tenant_id       = data.azurerm_subscription.current.tenant_id

  default_node_configuration = module.castai-aks-cluster.castai_node_configurations["default"]

  node_configurations = {
    default = {
      disk_cpu_ratio = 25
      subnets        = [azurerm_subnet.internal.id]
      tags           = {
        "node-config" : "default"
      }
    }
  }
  node_templates = {
    spot_tmpl = {
      configuration_id = module.castai-aks-cluster.castai_node_configurations["default"]

      should_taint = true

      custom_labels = {
        custom-label-key-1 = "custom-label-value-1"
        custom-label-key-2 = "custom-label-value-2"
      }

      custom_taints = [
        {
          key = "custom-taint-key-1"
          value = "custom-taint-value-1"
        },
        {
          key = "custom-taint-key-2"
          value = "custom-taint-value-2"
        }
      ]

      constraints = {
        fallback_restore_rate_seconds = 1800
        spot = true
        use_spot_fallbacks = true
        min_cpu = 4
        max_cpu = 100
        instance_families = {
          exclude = ["standard_DPLSv5"]
        }
        compute_optimized = false
        storage_optimized = false
      }
    }
  }
}

Examples

Usage examples are located in terraform provider repo

Requirements

Name	Version
terraform	>= 0.13
azuread	>= 2.22.0
azurerm	>= 3.7.0
castai	>= 3.3.0
helm	>= 2.0.0

Providers

Name	Version
azuread	>= 2.22.0
azurerm	>= 3.7.0
castai	>= 3.3.0
helm	>= 2.0.0

Modules

No modules.

Resources

Name	Type
azuread_application.castai	resource
azuread_application_password.castai	resource
azuread_service_principal.castai	resource
azurerm_role_assignment.castai_node_resource_group	resource
azurerm_role_assignment.castai_resource_group	resource
azurerm_role_definition.castai	resource
castai_aks_cluster.castai_cluster	resource
castai_autoscaler.castai_autoscaler_policies	resource
castai_node_configuration.this	resource
castai_node_configuration_default.this	resource
castai_node_template.this	resource
helm_release.castai_agent	resource
helm_release.castai_cluster_controller	resource
helm_release.castai_evictor	resource
helm_release.castai_kvisor	resource
helm_release.castai_spot_handler	resource
azuread_client_config.current	data source

Inputs

Name	Description	Type	Default	Required
agent_values	List of YAML formatted string values for agent helm chart	list(string)	[]	no
agent_version	Version of castai-agent helm chart. If not provided, latest version will be used.	string	null	no
aks_cluster_name	Name of the cluster to be connected to CAST AI.	string	n/a	yes
aks_cluster_region	Region of the AKS cluster	string	n/a	yes
api_url	URL of alternative CAST AI API to be used during development or testing	string	"https://api.cast.ai"	no
autoscaler_policies_json	Optional json object to override CAST AI cluster autoscaler policies	string	""	no
castai_components_labels	Optional additional Kubernetes labels for CAST AI pods	map	{}	no
cluster_controller_values	List of YAML formatted string values for cluster-controller helm chart	list(string)	[]	no
cluster_controller_version	Version of castai-cluster-controller helm chart. If not provided, latest version will be used.	string	null	no
default_node_configuration	ID of the default node configuration	string	n/a	yes
delete_nodes_on_disconnect	Optionally delete Cast AI created nodes when the cluster is destroyed	bool	false	no
evictor_values	List of YAML formatted string values for evictor helm chart	list(string)	[]	no
evictor_version	Version of castai-evictor chart. If not provided, latest version will be used.	string	null	no
install_security_agent	Optional flag for installation of security agent (https://docs.cast.ai/product-overview/console/security-insights/)	bool	false	no
kvisor_values	List of YAML formatted string values for kvisor helm chart	list(string)	[]	no
kvisor_version	Version of kvisor chart. If not provided, latest version will be used.	string	null	no
node_configurations	Map of AKS node configurations to create	any	{}	no
node_resource_group	n/a	string	n/a	yes
node_templates	Map of node templates to create	any	{}	no
resource_group	n/a	string	n/a	yes
spot_handler_values	List of YAML formatted string values for spot-handler helm chart	list(string)	[]	no
spot_handler_version	Version of castai-spot-handler helm chart. If not provided, latest version will be used.	string	null	no
subscription_id	Azure subscription ID	string	n/a	yes
tenant_id	n/a	string	n/a	yes

Outputs

Name	Description
castai_node_configurations	Map of node configurations ids by name
castai_node_templates	Map of node template by name
cluster_id	CAST.AI cluster id, which can be used for accessing cluster data using API