variables.tf

################################################################
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Licensed Materials - Property of IBM
#
# ©Copyright IBM Corp. 2020
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
################################################################

################################################################
# Configure the OpenStack Provider
################################################################
variable "user_name" {
  description = "The user name used to connect to OpenStack/PowerVC"
  default     = "my_user_name"
}

variable "password" {
  description = "The password for the user"
  default     = "my_password"
}

variable "tenant_name" {
  description = "The name of the project (a.k.a. tenant) used"
  default     = "ibm-default"
}

variable "domain_name" {
  description = "The domain to be used"
  default     = "Default"
}

variable "auth_url" {
  description = "The endpoint URL used to connect to OpenStack/PowerVC"
  default     = "https://<HOSTNAME>:5000/v3/"
}

variable "insecure" {
  default = "true" # OS_INSECURE
}

variable "openstack_availability_zone" {
  description = "The name of Availability Zone for deploy operation"
  default     = ""
}


################################################################
# Configure the Instance details
################################################################

variable "bastion" {
  default = {
    count         = 1
    instance_type = "m1.xlarge"
    image_id      = "daa5d3f4-ab66-4b2d-9f3d-77bd61774419"
    # optional availability_zone
    # availability_zone = ""
    # optional fixed IP address
    # fixed_ip_v4   = "123.45.67.89"
    # fixed_ips = []
  }
}
variable "bootstrap" {
  default = {
    # only one node is supported
    count         = 1
    instance_type = "m1.xlarge"
    # rhcos image id
    image_id = "468863e6-4b33-4e8b-b2c5-c9ef9e6eedf4"
    # optional availability_zone
    # availability_zone = ""
    # optional fixed IPs
    # fixed_ips = []
  }
}

variable "master" {
  default = {
    count         = 3
    instance_type = "m1.xlarge"
    # rhcos image id
    image_id = "468863e6-4b33-4e8b-b2c5-c9ef9e6eedf4"
    # optional availability_zone
    # availability_zone = ""
    # optional fixed IPs
    # fixed_ips = []
    # optional data volumes to master nodes
    # data_volume_size = 100 #Default volume size (in GB) to be attached to the master nodes.
    # data_volume_count = 0 #Number of volumes to be attached to each master node.
  }
}

variable "worker" {
  default = {
    count         = 2
    instance_type = "m1.xlarge"
    # rhcos image id
    image_id = "468863e6-4b33-4e8b-b2c5-c9ef9e6eedf4"
    # optional availability_zone
    # availability_zone = ""
    # optional fixed IPs
    # fixed_ips = []
    # optional data volumes to worker nodes
    # data_volume_size = 100 #Default volume size (in GB) to be attached to the worker nodes.
    # data_volume_count = 0 #Number of volumes to be attached to each worker node.
  }
}

variable "network_name" {
  description = "The name of the network to be used for deploy operations"
  default     = "my_network_name"
}

variable "network_type" {
  #Eg: SEA or SRIOV
  default     = "SEA"
  description = "Specify the name of the network adapter type to use for creating hosts"
}

variable "sriov_vnic_failover_vfs" {
  # Eg: 1 = VNIC without failover; 2 = VNIC failover with 2 SR-IOV VFs
  default     = 1
  description = "Specifies the amount of VNIC failover virtual functions (max. is 6)"
  validation {
    condition     = var.sriov_vnic_failover_vfs > 0 && var.sriov_vnic_failover_vfs < 7
    error_message = "The number of virtual functions for the parameter sriov_vnic_failover_vfs must be min. 1 and cannot exceed 6."
  }
}

variable "sriov_capacity" {
  # Eg: 0.02 = 2%; 0.20 = 20%; 1.00 = 100%
  default     = 0.02
  description = "Specifies the SR-IOV LP capacity"
}

variable "scg_id" {
  description = "The id of PowerVC Storage Connectivity Group to use for all nodes"
  default     = ""
}

variable "scg_flavor_is_public" {
  description = "Newly created compute template will be private by default. User can set this to true to make it visible in UI"
  default     = false
}

variable "rhel_username" {
  default = "root"
}

variable "keypair_name" {
  # Set this variable to the name of an already generated
  # keypair to use it instead of creating a new one.
  default = ""
}

variable "public_key_file" {
  description = "Path to public key file"
  # if empty, will default to ${path.cwd}/data/id_rsa.pub
  default = ""
}

variable "private_key_file" {
  description = "Path to private key file"
  # if empty, will default to ${path.cwd}/data/id_rsa
  default = ""
}

variable "private_key" {
  description = "content of private ssh key"
  # if empty string will read contents of file at var.private_key_file
  default = ""
}

variable "public_key" {
  description = "Public key"
  # if empty string will read contents of file at var.public_key_file
  default = ""
}

variable "rhel_subscription_username" {
  default = ""
}

variable "rhel_subscription_password" {
  default = ""
}

variable "rhel_subscription_org" {
  default = ""
}

variable "rhel_subscription_activationkey" {
  default = ""
}

variable "rhcos_pre_kernel_options" {
  description = "List of kernel arguments for the cluster nodes for pre-installation"
  default     = []
}

variable "rhcos_kernel_options" {
  description = "List of kernel arguments for the cluster nodes"
  default     = []
}

variable "sysctl_tuned_options" {
  description = "Set to true to apply sysctl options via tuned operator. Default: false"
  default     = false
}

variable "sysctl_options" {
  description = "List of sysctl options to apply."
  default     = []
}

variable "match_array" {
  description = "Criteria for node/pod selection."
  default     = <<EOF
EOF
}

variable "chrony_config" {
  description = "Set to true to setup time synchronization and setup chrony. Default: false"
  default     = true
}

variable "chrony_config_servers" {
  description = "List of ntp servers and options to apply"
  default     = []
  # example: chrony_config_servers = [ {server = "10.3.21.254", options = "iburst"}, {server = "10.5.21.254", options = "iburst"} ]
}

################################################################
### Instrumentation
################################################################
variable "ssh_agent" {
  description = "Enable or disable SSH Agent. Can correct some connectivity issues. Default: false"
  default     = false
}

variable "connection_timeout" {
  description = "Timeout in minutes for SSH connections"
  default     = 45
}

variable "jump_host" {
  description = "Jump server hostname/IP to be used for SSH connections"
  default     = ""
}

variable "private_network_mtu" {
  type        = number
  description = "MTU value for the private network interface on RHEL and RHCOS nodes"
  default     = 1450
}

variable "installer_log_level" {
  description = "Set the log level required for openshift-install commands"
  default     = "info"
}

variable "helpernode_repo" {
  description = "Set the repo URL for using ocp4-helpernode"
  # Repo for running ocp4 helpernode setup steps.
  default = "https://github.com/RedHatOfficial/ocp4-helpernode"
}

variable "helpernode_tag" {
  description = "Set the branch/tag name or commit# for using ocp4-helpernode repo"
  # Checkout level for https://github.com/RedHatOfficial/ocp4-helpernode which is used for setting up services required on bastion node
  default = "f36e843ae24929dcd56bb99049ef157e6dddbc72"
}

variable "install_playbook_repo" {
  description = "Set the repo URL for using ocp4-playbooks"
  # Repo for running ocp4 installations steps.
  default = "https://github.com/ocp-power-automation/ocp4-playbooks"
}

variable "install_playbook_tag" {
  description = "Set the branch/tag name or commit# for using ocp4-playbooks repo"
  # Checkout level for https://github.com/ocp-power-automation/ocp4-playbooks which is used for running ocp4 installations steps
  default = "main"
}

variable "ansible_extra_options" {
  description = "Extra options string to append to ansible-playbook commands"
  default     = "-v"
}

variable "ansible_repo_name" {
  default = "ansible-2.9-for-rhel-8-ppc64le-rpms"
}

locals {
  private_key_file = var.private_key_file == "" ? "${path.cwd}/data/id_rsa" : var.private_key_file
  public_key_file  = var.public_key_file == "" ? "${path.cwd}/data/id_rsa.pub" : var.public_key_file
  private_key      = var.private_key == "" ? file(coalesce(local.private_key_file, "/dev/null")) : var.private_key
  public_key       = var.public_key == "" ? file(coalesce(local.public_key_file, "/dev/null")) : var.public_key
  create_keypair   = var.keypair_name == "" ? "1" : "0"
}


################################################################
### OpenShift variables
################################################################
variable "openshift_install_tarball" {
  default = "https://mirror.openshift.com/pub/openshift-v4/ppc64le/clients/ocp/stable/openshift-install-linux.tar.gz"
}

variable "openshift_client_tarball" {
  default = "https://mirror.openshift.com/pub/openshift-v4/ppc64le/clients/ocp/stable/openshift-client-linux.tar.gz"
}

variable "release_image_override" {
  default = ""
}

variable "pull_secret_file" {
  default = "data/pull-secret.txt"
}
# Must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character
variable "cluster_domain" {
  default = "rhocp.com"
}
# Must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character
# Should not be more than 14 characters
variable "cluster_id_prefix" {
  default = "test-ocp"
}
# Must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character
# Length cannot exceed 14 characters when combined with cluster_id_prefix
variable "cluster_id" {
  default = ""
}

variable "fips_compliant" {
  type        = bool
  description = "Set to true to enable usage of FIPS for OCP deployment."
  default     = false
}

variable "dns_forwarders" {
  default = "8.8.8.8; 8.8.4.4"
}

variable "lb_ipaddr" {
  description = "Define the preconfigured external Load Balancer"
  default     = ""
}

variable "ext_dns" {
  description = "Define the preconfigured external DNS and Load Balancer"
  default     = ""
}

variable "mount_etcd_ramdisk" {
  description = "Whether mount etcd directory in the ramdisk (Only for dev/test) on low performance disk"
  default     = false
}

variable "setup_squid_proxy" {
  description = "Flag to install and configure squid proxy server on bastion node"
  default     = false
}

# Applicable only when `setup_squid_proxy = false`
variable "proxy" {
  description = "External proxy server details in a map of server, port(default=3128), user & password"
  default     = {}
  #    default = {
  #        server = "10.10.1.166",
  #        port = "3128"
  #        user = "pxuser",
  #        password = "pxpassword"
  #    }
}

variable "storage_type" {
  #Supported values: nfs (other value won't setup a storageclass)
  default = "nfs"
}

variable "volume_size" {
  # If storage_type = nfs, a new volume of this size will be attached to the bastion node.
  # Value in GB
  default = "300"
}

variable "volume_storage_template" {
  # Storage template name or ID for creating the volume.
  default = ""
}

variable "upgrade_version" {
  description = "OCP upgrade version eg. 4.11.4"
  default     = ""
}

variable "upgrade_channel" {
  description = "Upgrade channel having required version availble for cluster upgrade (stable-4.x, fast-4.x, candidate-4.x) eg. stable-4.11"
  default     = ""
}

variable "upgrade_image" {
  description = "OCP upgrade image e.g. quay.io/openshift-release-dev/ocp-release-nightly@sha256:xxxxx"
  default     = ""
}

variable "upgrade_pause_time" {
  description = "Number of minutes to pause the playbook execution before starting to check the upgrade status once the upgrade command is executed."
  default     = "90"
}

variable "upgrade_delay_time" {
  description = "Number of seconds to wait before re-checking the upgrade status once the playbook execution resumes."
  default     = "600"
}

variable "eus_upgrade_version" {
  description = "OCP eus upgrade version eg. 4.11.4"
  default     = ""
}

variable "eus_upgrade_channel" {
  description = "Upgrade channel having required version availble for cluster upgrade (stable-4.x, fast-4.x, candidate-4.x, eus-4.x) eg. stable-4.11"
  default     = ""
}

variable "eus_upgrade_image" {
  description = "OCP upgrade image e.g. quay.io/openshift-release-dev/ocp-release-nightly@sha256:xxxxx"
  default     = ""
}

variable "eus_upstream" {
  description = "URL for OCP update server eg. https://ppc64le.ocp.releases.ci.openshift.org/graph"
  default     = ""
}

variable "cni_network_provider" {
  description = "Set the default Container Network Interface (CNI) network provider"
  default     = "OVNKubernetes"
}

variable "cluster_network_cidr" {
  description = "blocks of IP addresses from which pod IP addresses are allocated."
  default     = "10.128.0.0/14"
}

variable "cluster_network_hostprefix" {
  description = "The subnet prefix length to assign to each individual node."
  default     = "23"
}

variable "service_network" {
  description = "blocks of IP addresses from which service addresses are allocated."
  default     = "172.30.0.0/16"
}

################################################################
# Local registry variables ( used only in disconnected install )
################################################################
variable "enable_local_registry" {
  description = "Set to true to enable usage of local registry for restricted network install."
  type        = bool
  default     = false
}

variable "local_registry_image" {
  description = "Name of the image used for creating the local registry container."
  default     = "docker.io/library/registry:2"
}

variable "ocp_release_tag" {
  description = "The version of OpenShift you want to sync."
  default     = "4.4.9-ppc64le"
}


################################################################
# LUKS variables
################################################################

variable "luks_compliant" {
  type        = bool
  description = "Set to true to enable usage of LUKS for OCP deployment."
  default     = false
}

variable "luks_config" {
  type = list(object({
    thumbprint = string,
    url        = string
  }))
  description = "List of tang servers and thumbprint to apply"
  default     = []
}

variable "luks_filesystem_device" {
  type        = string
  description = "Path of device to be luks encrypted"
  default     = "/dev/mapper/root"
}

variable "luks_format" {
  type        = string
  description = "Format of the FileSystem to be luks encrypted"
  default     = "xfs"
}

variable "luks_wipe_filesystem" {
  type        = bool
  description = "Configures the FileSystem to be wiped"
  default     = true
}

variable "luks_device" {
  type        = string
  description = "Path of luks encrypted partition"
  default     = "/dev/disk/by-partlabel/root"
}

variable "luks_label" {
  type        = string
  description = "User label of luks encrypted partition"
  default     = "luks-root"
}

variable "luks_options" {
  type        = list(string)
  description = "List of luks options for the luks encryption"
  default     = ["--cipher", "aes-cbc-essiv:sha256"]
}

variable "luks_wipe_volume" {
  type        = bool
  description = "Configures the luks encrypted partition to be wiped"
  default     = true
}

variable "luks_name" {
  type        = string
  description = "User label of Filesystem to be luks encrypted"
  default     = "root"
}


################################################################
# KDUMP variables
################################################################


variable "kdump_enable" {
  type        = bool
  description = "Set to true to enable the kdump on Cluster Nodes"
  default     = false
}
variable "kdump_commandline_remove" {
  type        = string
  description = "This option removes arguments from the current kdump command line"
  default     = "hugepages hugepagesz slub_debug quiet log_buf_len swiotlb"
}
variable "kdump_commandline_append" {
  type        = string
  description = "This option appends arguments to the current kdump command line"
  default     = "irqpoll maxcpus=1 reset_devices cgroup_disable=memory mce=off numa=off udev.children-max=2 panic=10 rootflags=nofail acpi_no_memhotplug transparent_hugepage=never nokaslr novmcoredd hest_disable srcutree.big_cpu_lim=0"
}
variable "kdump_kexec_args" {
  type        = string
  description = "For adding any extra argument to pass to kexec command"
  default     = "-s"
}
variable "kdump_img" {
  type        = string
  description = "For specifying image other than default kernel image"
  default     = "vmlinuz"
}
variable "kdump_log_path" {
  type        = string
  description = "The file system path in which the kdump saves the vmcore file"
  default     = "/var/crash"
}
variable "kdump_crash_kernel_memory" {
  type        = string
  description = "The crashkernel memory reservation for kdump occurs during the system boot"
  default     = "2G-4G:384M,4G-16G:512M,16G-64G:1G,64G-128G:2G,128G-:4G"
}

################################################################
# Secure service variables
################################################################

variable "secure_named" {
  type        = bool
  description = "Flag to enable the secure_named which limits DNS transfers"
  default     = false
}
variable "secure_http" {
  type        = bool
  description = "Flag to enable the secure_http which disables Track/Trace for httpd server."
  default     = false
}
variable "secure_nfs" {
  type        = bool
  description = "Flag to enable the secure_nfs which limits the access of NFS server to the compute/control plane"
  default     = false
}