Skip to content

Latest commit

 

History

History
120 lines (93 loc) · 5.19 KB

ADVANCED.md

File metadata and controls

120 lines (93 loc) · 5.19 KB
Raw

Advanced usage

Use terraform variable files

To avoid using multiple main.tf files having the same deployment and just some variables differences, use the tfvars files with a main template to deploy environment. For this example, we will have four types of files:

main.tf

Deployment description using variables for environment specific parameters

Example :

    server = {
      provider_settings = {
        mac = var.ENVIRONMENT_CONFIGURATION[var.ENVIRONMENT].mac["server"]
        vcpu = 8
        memory = 32768
      }
      additional_repos_only = var.ADDITIONAL_REPOS_ONLY
      additional_repos = local.additional_repos["server"]
      image = var.IMAGE
      additional_packages = [ "venv-salt-minion" ]
      install_salt_bundle = true
      server_mounted_mirror = var.MIRROR
    }

variable.tf

Remove all the variables from the main.tf file and move it to a specific one. Example :

variable "BRIDGE" {
  type = string
}

variable "ADDITIONAL_REPOS_ONLY" {
  type = bool
}

variable "ENVIRONMENT_CONFIGURATION" {
  type = map
  description = "Collection of  value containing : mac addresses, hypervisor and additional network"
}

variable "DOWNLOAD_ENDPOINT" {
  type = string
  description = "Download endpoint to get build images and set custom_download_endpoint. This value is equal to platform mirror"
}

Custom terraform variable files (XXX.tfvars)

You can have as many as you want. Specify the variables depending on the environment. For example mac addresses depending on NUE or PRV environment

Example :

############ Nuremberg unique variables ###########

DOMAIN            = "mgr.suse.de"
MIRROR            = "minima-mirror-ci-bv.mgr.suse.de"
DOWNLOAD_ENDPOINT = "minima-mirror-ci-bv.mgr.suse.de"
USE_MIRROR_IMAGES = true
GIT_PROFILES_REPO = "https://github.com/uyuni-project/uyuni.git#:testsuite/features/profiles/internal_nue"
BRIDGE            = "br0"
ENVIRONMENT_CONFIGURATION = {
  1 = {
    mac = {
      controller     = "aa:b2:93:01:03:50"
      server         = "aa:b2:93:01:03:51"
      proxy          = "aa:b2:93:01:03:52"
      suse-minion    = "aa:b2:93:01:03:54"
      suse-sshminion = "aa:b2:93:01:03:55"
      rhlike-minion  = "aa:b2:93:01:03:56"
      deblike-minion = "aa:b2:93:01:03:57"
      build-host     = "aa:b2:93:01:03:59"
      kvm-host       = "aa:b2:93:01:03:5a"
      nested-vm      = "aa:b2:93:01:03:5b"
    }
    hypervisor = "suma-08.mgr.suse.de"
    additional_network = "192.168.111.0/24"
  }
}

Deploying environment depending on the product version, environment

sh "rm -f ${env.resultdir}/sumaform/terraform.tfvars"
sh "cat ${tfvars_manager43} ${tfvars_nuremberg} >> ${env.resultdir}/sumaform/terraform.tfvars"
sh "echo 'ENVIRONMENT = \'${env_number}\'' >> ${env.resultdir}/sumaform/terraform.tfvars"
sh "cp ${tf_local_variables} ${env.resultdir}/sumaform/"

Deploy a Limited Environment Using a Full Deployment Declaration (e.g., for Build Validation Deployment)

To set up a limited environment, start with a main.tf file that declares all the necessary resources. Once you have this main.tf, you can use the --use-tf-resource-cleaner option alongside --tf-resources-to-keep to retain specific minions and --tf-resources-to-delete to exclude retail minions or the monitoring server from the deployment.

In this example, we have a base main.tf (base_main_tf_path) that includes a server, proxy, monitoring server, retail minions, and all the minions needed for Build Validation. With the following command, the new main.tf will only include the server, proxy, sles15sp5-sshminion, sles15sp6-sshminion, sles15sp4-client, and rocky8-minion. The resulting main.tf will be copied into the sumaform_folder:

./terracumber-cli --tf base_main_tf_path --gitfolder sumaform_folder --sumaform-backend libvirt --use-tf-resource-cleaner --tf-resources-to-delete monitoring-server retail --tf-resources-to-keep sles15sp5-sshminion sles15sp6-sshminion sles15sp4-client rocky8-minion --runstep provision

Clean an Environment While Retaining Only the Server and Controller (e.g., for Build Validation Deployment)

To clean an environment while keeping the server and controller intact, you’ll need an existing deployment with access to the tfstate file. The goal is to redeploy the environment without deleting the server and controller.

To achieve this, use the --use-tf-resource-cleaner option and specify the resources to remove with --tf-resources-to-delete, such as the proxy, monitoring server, and retail resources.

Assuming you have a deployment in the original_folder, this folder should contain a main.tf file with everything declared and a terraform.tfstate file describing the deployment. You can clean up the environment by copying the state and configuration files to a new folder and running the cleanup command.

sh "cp original_folder/sumaform/terraform.tfstate cleanup_folder/sumaform/terraform.tfstate"
sh "cp -r original_folder/sumaform/.terraform cleanup_folder/sumaform/"
sh "./terracumber-cli -tf base_main_tf_path --gitfolder cleanup_folder/sumaform --sumaform-backend libvirt --use-tf-resource-cleaner --tf-resources-to-delete proxy monitoring-server retail --runstep provision"