https://github.com/terraform-cisco-modules/terraform-intersight-iks

Intersight Kubernetes Service
https://github.com/terraform-cisco-modules/terraform-intersight-iks
Last synced: about 1 month ago
JSON representation
Intersight Kubernetes Service
Host: GitHub
URL: https://github.com/terraform-cisco-modules/terraform-intersight-iks
Owner: terraform-cisco-modules
License: gpl-3.0
Created: 2021-02-08T20:15:12.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2022-07-16T05:12:23.000Z (almost 3 years ago)
Last Synced: 2025-03-28T13:15:39.325Z (about 2 months ago)
Language: HCL
Size: 327 KB
Stars: 11
Watchers: 7
Forks: 28
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

[![Developed by: Cisco](https://img.shields.io/badge/Developed%20by-Cisco-blue)](https://developer.cisco.com)

[![published](https://static.production.devnetcloud.com/codeexchange/assets/images/devnet-published.svg)](https://developer.cisco.com/codeexchange/github/repo/terraform-cisco-modules/terraform-intersight-iks)

# Terraform Intersight Kubernetes Service Module

The Cisco Intersight Terraform Provider is available in the Terraform Registry at https://registry.terraform.io/providers/CiscoDevNet/intersight/latest.  This repository contains example modules that use the provider to create 

A terraform module to create a managed Kubernetes clusters using Intersight Kubernetes Service (IKS). Available through the [Terraform registry](https://registry.terraform.io/providers/CiscoDevNet/intersight/latest) and its [source code](https://github.com/CiscoDevNet/terraform-provider-intersight).

## CAVEAT

* You cannot assign the cluster action as "Deploy" and "wait_for_completion" as TRUE at the same time.

## Assumptions

* You want to create an IKS cluster on your on-premises infrastructure using Intersight.

* These resources will be provided using Intersight and VMware vCenter 6.7.

* You've claimed vCenter using the Intersight Assist Appliance.

## Details

This module creates all of the resources required for IKS.  Those resources are identitified below.  It is designed as a quickstart/example of how to get an IKS cluster running.  More customization is being enabled but currently there are some caveats:

Reusing prebuilt policies is supported.  Each object block has a variable for doing this.

Set

```hcl

use_existing = true

```

If existing objects are not available this module will create those objects for you where required.

Set

```hcl

use_existing = false

```

For the runtime_policies and the Trusted registry, if you DO NOT want to use this policy in your cluster build you need to set the following variable combination in EACH object block.

```hcl

  use_existing         = false

  create_new           = false

```

## Usage

See the [Examples](https://github.com/terraform-cisco-modules/terraform-intersight-iks/tree/main/examples) ---> Complete directory for usage of this module.

There are 4 example files below that are needed to use this module.  Create these files in the same directory, run terraform init.  You will then be ready to run terraform plan or terraform apply.

Change the variables in the terraform.tfvars file and the main.tf as needed.

See the above Examples folder for more information.

Sample main.tf file.  

```hcl

provider "intersight" {

  apikey    = var.apikey

  secretkey = var.secretkey

  endpoint  = var.endpoint

}

module "terraform-intersight-iks" {

  source  = "terraform-cisco-modules/iks/intersight//"

  version = "~>2.4.0"

# Kubernetes Cluster Profile  Adjust the values as needed.

  cluster = {

    name                = "new_cluster"

    action              = "Unassign"

    wait_for_completion = false

    worker_nodes        = 5

    load_balancers      = 5

    worker_max          = 20

    control_nodes       = 1

    ssh_user            = var.ssh_user

    ssh_public_key      = var.ssh_key

  }

# IP Pool Information (To create new change "use_existing" to 'false' uncomment variables and modify them to meet your needs.)

  ip_pool = {

    use_existing        = true

    name                = "10-239-21-0"

    # ip_starting_address = "10.239.21.220"

    # ip_pool_size        = "20"

    # ip_netmask          = "255.255.255.0"

    # ip_gateway          = "10.239.21.1"

    # dns_servers         = ["10.101.128.15","10.101.128.16"]

  }

# Sysconfig Policy (UI Reference NODE OS Configuration) (To create new change "use_existing" to 'false' uncomment variables and modify them to meet your needs.)

  sysconfig = {

    use_existing = true

    name         = "richfield"

    # domain_name  = "rich.ciscolabs.com"

    # timezone     = "America/New_York"

    # ntp_servers  = ["10.101.128.15"]

    # dns_servers  = ["10.101.128.15"]

  }

# Kubernetes Network CIDR (To create new change "use_existing" to 'false' uncomment variables and modify them to meet your needs.)

  k8s_network = {

    use_existing = true

    name         = "default"

    ######### Below are the default settings.  Change if needed. #########

    # pod_cidr     = "100.65.0.0/16"

    # service_cidr = "100.64.0.0/24"

    # cni          = "Calico"

  }

# Version policy (To create new change "useExisting" to 'false' uncomment variables and modify them to meet your needs.)

  versionPolicy = {

    useExisting = true

    policyName     = "1-19-15-iks.3"

    iksVersionName = "1.19.15-iks.3"

  }

# Trusted Registry Policy (To create new change "use_existing" to 'false' and set "create_new' to 'true' uncomment variables and modify them to meet your needs.)

# Set both variables to 'false' if this policy is not needed.

  tr_policy = {

    use_existing = false

    create_new   = false

    name         = "trusted-registry"

  }

# Runtime Policy (To create new change "use_existing" to 'false' and set "create_new' to 'true' uncomment variables and modify them to meet your needs.)

# Set both variables to 'false' if this policy is not needed.

  runtime_policy = {

    use_existing = false

    create_new   = false

    # name                 = "runtime"

    # http_proxy_hostname  = "t"

    # http_proxy_port      = 80

    # http_proxy_protocol  = "http"

    # http_proxy_username  = null

    # http_proxy_password  = null

    # https_proxy_hostname = "t"

    # https_proxy_port     = 8080

    # https_proxy_protocol = "https"

    # https_proxy_username = null

    # https_proxy_password = null

  }

# Infrastructure Configuration Policy (To create new change "use_existing" to 'false' and uncomment variables and modify them to meet your needs.)

  infraConfigPolicy = {

    use_existing = true

    # platformType = "iwe"

    # targetName   = "falcon"

    policyName   = "dev"

    # description  = "Test Policy"

    # interfaces   = ["iwe-guests"]

    # vcTargetName   = optional(string)

    # vcClusterName      = optional(string)

    # vcDatastoreName     = optional(string)

    # vcResourcePoolName = optional(string)

    # vcPassword      = optional(string)

  }

# Addon Profile and Policies (To create new change "createNew" to 'true' and uncomment variables and modify them to meet your needs.)

# This is an Optional item.  Comment or remove to not use.  Multiple addons can be configured.

  addons       = [

    {

    createNew = true

    addonPolicyName = "smm-tf"

    addonName            = "smm"

    description       = "SMM Policy"

    upgradeStrategy  = "AlwaysReinstall"

    installStrategy  = "InstallOnly"

    releaseVersion = "1.7.4-cisco4-helm3"

    overrides = yamlencode({"demoApplication":{"enabled":true}})

    },

    # {

    # createNew = true

    # addonName            = "ccp-monitor"

    # description       = "monitor Policy"

    # # upgradeStrategy  = "AlwaysReinstall"

    # # installStrategy  = "InstallOnly"

    # releaseVersion = "0.2.61-helm3"

    # # overrides = yamlencode({"demoApplication":{"enabled":true}})

    # }

  ]

# Worker Node Instance Type (To create new change "use_existing" to 'false' and uncomment variables and modify them to meet your needs.)

  instance_type = {

    use_existing = true

    name         = "small"

    # cpu          = 4

    # memory       = 16386

    # disk_size    = 40

  }

# Organization and Tag Information

  organization = var.organization

  tags         = var.tags

}

```

Sample terraform.tfvars file.

```hcl

apikey       = ""

secretkey    = "../../.secret"

organization = "default"

ssh_user = "iksadmin"

ssh_key  = ""

tags = [

  {

    "key" : "managed_by"

    "value" : "Terraform"

  },

  {

    "key" : "owner"

    "value" : "jb"

  }

]

organization = "default" # Change this if a different org is required.  Default org is set to "default"

```

Sample versions.tf file

```hcl

terraform {

  required_version = ">=1.1.0"

  required_providers {

    intersight = {

      source  = "CiscoDevNet/intersight"

      version = ">=1.0.18"

    }

  }

}

```

Sample variables.tf file.

```hcl

variable "apikey" {

  type        = string

  description = "API Key"

}

variable "secretkey" {

  type        = string

  description = "Secret Key or file location"

}

variable "endpoint" {

  type        = string

  description = "API Endpoint URL"

  default     = "https://www.intersight.com"

}

variable "organization" {

  type        = string

  description = "Organization Name"

  default     = "default"

}

variable "ssh_user" {

  type        = string

  description = "SSH Username for node login."

}

variable "ssh_key" {

  type        = string

  description = "SSH Public Key to be used to node login."

}

variable "tags" {

  type    = list(map(string))

  default = []

}

```

**Always check [Kubernetes Release Notes](https://kubernetes.io/docs/setup/release/notes/) before updating the major version.**

## Requirements

| Name | Version |

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

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

|  [intersight](#requirement\_intersight) | >=1.0.18 |

## Providers

| Name | Version |

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

|  [intersight](#provider\_intersight) | >=1.0.18 |

## Modules

| Name | Source | Version |

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

|  [addons](#module\_addons) | ./modules/addon_policy | n/a |

|  [cluster\_addon\_profile](#module\_cluster\_addon\_profile) | ./modules/cluster_addon_profile | n/a |

|  [cluster\_profile](#module\_cluster\_profile) | ./modules/cluster | n/a |

|  [control\_profile](#module\_control\_profile) | ./modules/node_profile | n/a |

|  [control\_provider](#module\_control\_provider) | ./modules/infra_provider | n/a |

|  [infra\_config\_policy](#module\_infra\_config\_policy) | ./modules/infra_config_policy | n/a |

|  [instance\_type](#module\_instance\_type) | ./modules/worker_profile | n/a |

|  [ip\_pool\_policy](#module\_ip\_pool\_policy) | ./modules/ip_pool | n/a |

|  [k8s\_network](#module\_k8s\_network) | ./modules/k8s_network | n/a |

|  [k8s\_sysconfig](#module\_k8s\_sysconfig) | ./modules/k8s_sysconfig | n/a |

|  [k8s\_version](#module\_k8s\_version) | ./modules/version | n/a |

|  [runtime\_policy](#module\_runtime\_policy) | ./modules/runtime_policy | n/a |

|  [trusted\_registry](#module\_trusted\_registry) | ./modules/trusted_registry | n/a |

|  [worker\_profile](#module\_worker\_profile) | ./modules/node_profile | n/a |

|  [worker\_provider](#module\_worker\_provider) | ./modules/infra_provider | n/a |

## Resources

| Name | Type |

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

| [intersight_ippool_pool.this](https://registry.terraform.io/providers/CiscoDevNet/intersight/latest/docs/data-sources/ippool_pool) | data source |

| [intersight_kubernetes_container_runtime_policy.this](https://registry.terraform.io/providers/CiscoDevNet/intersight/latest/docs/data-sources/kubernetes_container_runtime_policy) | data source |

| [intersight_kubernetes_network_policy.this](https://registry.terraform.io/providers/CiscoDevNet/intersight/latest/docs/data-sources/kubernetes_network_policy) | data source |

| [intersight_kubernetes_sys_config_policy.this](https://registry.terraform.io/providers/CiscoDevNet/intersight/latest/docs/data-sources/kubernetes_sys_config_policy) | data source |

| [intersight_kubernetes_trusted_registries_policy.this](https://registry.terraform.io/providers/CiscoDevNet/intersight/latest/docs/data-sources/kubernetes_trusted_registries_policy) | data source |

| [intersight_kubernetes_version_policy.this](https://registry.terraform.io/providers/CiscoDevNet/intersight/latest/docs/data-sources/kubernetes_version_policy) | data source |

| [intersight_kubernetes_virtual_machine_infra_config_policy.this](https://registry.terraform.io/providers/CiscoDevNet/intersight/latest/docs/data-sources/kubernetes_virtual_machine_infra_config_policy) | data source |

| [intersight_kubernetes_virtual_machine_instance_type.this](https://registry.terraform.io/providers/CiscoDevNet/intersight/latest/docs/data-sources/kubernetes_virtual_machine_instance_type) | data source |

## Inputs

| Name | Description | Type | Default | Required |

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

|  [addons](#input\_addons) | n/a | 
list(object({
    createNew        = bool
    addonPolicyName  = optional(string)
    addonName        = optional(string)
    description      = optional(string)
    upgradeStrategy  = optional(string)
    installStrategy  = optional(string)
    overrideSets     = optional(list(map(string)))
    overrides        = optional(string)
    releaseName      = optional(string)
    releaseNamespace = optional(string)
    releaseVersion   = optional(string)
  })) | `[]` | no |

|  [cluster](#input\_cluster) | n/a | object({
    name                = string
    action              = string
    wait_for_completion = bool
    worker_nodes        = number
    load_balancers      = number
    worker_max          = number
    control_nodes       = number
    ssh_user            = string
    ssh_public_key      = string
  }) | n/a | yes |

|  [infraConfigPolicy](#input\_infraConfigPolicy) | n/a | object({
    use_existing       = bool
    platformType       = optional(string)
    targetName         = optional(string)
    policyName         = string
    description        = optional(string)
    interfaces         = optional(list(string))
    diskMode           = optional(string)
    vcTargetName       = optional(string)
    vcClusterName      = optional(string)
    vcDatastoreName    = optional(string)
    vcResourcePoolName = optional(string)
    vcPassword         = optional(string)
  }) | n/a | yes |

|  [infra\_config\_policy\_name](#input\_infra\_config\_policy\_name) | Name of existing infra config policy (if it exists) to be used. | `string` | `""` | no |

|  [instance\_type](#input\_instance\_type) | n/a | object({
    use_existing = bool
    name         = string
    cpu          = optional(number)
    memory       = optional(number)
    disk_size    = optional(number)
  }) | n/a | yes |

|  [ip\_pool](#input\_ip\_pool) | n/a | object({
    use_existing        = bool
    name                = string
    ip_starting_address = optional(string)
    ip_pool_size        = optional(string)
    ip_netmask          = optional(string)
    ip_gateway          = optional(string)
    dns_servers         = optional(list(string))
  }) | n/a | yes |

|  [k8s\_network](#input\_k8s\_network) | n/a | object({
    use_existing = bool
    name         = optional(string)
    pod_cidr     = optional(string)
    service_cidr = optional(string)
    cni          = optional(string)
  }) | n/a | yes |

|  [k8s\_network\_policy\_name](#input\_k8s\_network\_policy\_name) | Name of existing K8s Network Policy (if it exists) to be used. | `string` | `""` | no |

|  [organization](#input\_organization) | Organization Name | `string` | `"default"` | no |

|  [runtime\_policy](#input\_runtime\_policy) | n/a | object({
    use_existing         = bool
    create_new           = bool
    name                 = optional(string)
    http_proxy_hostname  = optional(string)
    http_proxy_port      = optional(number)
    http_proxy_protocol  = optional(string)
    http_proxy_username  = optional(string)
    http_proxy_password  = optional(string)
    https_proxy_hostname = optional(string)
    https_proxy_port     = optional(number)
    https_proxy_protocol = optional(string)
    https_proxy_username = optional(string)
    https_proxy_password = optional(string)
    docker_no_proxy      = optional(list(string))
  }) | n/a | yes |

|  [sysconfig](#input\_sysconfig) | n/a | object({
    use_existing = bool
    name         = string
    ntp_servers  = optional(list(string))
    dns_servers  = optional(list(string))
    timezone     = optional(string)
    domain_name  = optional(string)
  }) | n/a | yes |

|  [tags](#input\_tags) | n/a | `list(map(string))` | `[]` | no |

|  [tr\_policy](#input\_tr\_policy) | n/a | object({
    use_existing        = bool
    create_new          = bool
    name                = optional(string)
    root_ca_registries  = optional(list(string))
    unsigned_registries = optional(list(string))
  }) | n/a | yes |

|  [versionPolicy](#input\_versionPolicy) | n/a | object({
    useExisting    = bool
    policyName     = string
    iksVersionName = optional(string)
    description    = optional(string)
    versionName    = optional(string)
  })
 | n/a | yes |

## Outputs

| Name | Description |

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

|  [k8s\_cluster\_ca\_certificate](#output\_k8s\_cluster\_ca\_certificate) | n/a |

|  [k8s\_cluster\_client\_certificate](#output\_k8s\_cluster\_client\_certificate) | n/a |

|  [k8s\_cluster\_client\_key](#output\_k8s\_cluster\_client\_key) | n/a |

|  [k8s\_cluster\_host](#output\_k8s\_cluster\_host) | n/a |

|  [k8s\_cluster\_kubeconfig](#output\_k8s\_cluster\_kubeconfig) | n/a |

|  [k8s\_cluster\_moid](#output\_k8s\_cluster\_moid) | n/a |

|  [k8s\_cluster\_profile\_moid](#output\_k8s\_cluster\_profile\_moid) | n/a |
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/terraform-cisco-modules/terraform-intersight-iks

Awesome Lists containing this project

README
