This module creates a resource group, a VPC in that resource group, IAM Access Groups, and invites users to those Access Groups. It then creates a Red Hat OpenShift Cluster on that VPC
- Access Groups
- VPC
- Public Gateways
- Network ACL
- Subnets
- Cloud Object Storage
- Red Hat OpenShift Cluster
- Module Variables
- Module Outputs
- As A Module in a Larger Architecture
The iam module creates any number of access groups, with any number of policies.
The flexible access_groups
variable allows users to dynamically create groups with complex rules using a single object.
Users can be invited to these groups. Users invited to these access groups will be added to the access group even if they have not yet accepted the invite to the account. (If you do not need to invite users, delete ./iam/invite_users.tf and remove invite_users
fom the access_group
variable definition.)
list(
object({
name = string # Name of the group
description = string # Description of group
policies = list(
object({
name = string # Name of the policy
roles = list(string) # list of roles for the policy
resources = object({
resource_group = optional(string) # Name of the resource group the policy will apply to
resource_type = optional(string) # Name of the resource type for the policy ex. "resource-group"
service = optional(string) # Name of the service type for the policy ex. "cloud-object-storage"
resource_instance_id = optional(string) # ID of a service instance to give permissions
})
})
)
dynamic_policies = optional(
list(
object({
name = string # Dynamic group name
identity_provider = string # URI for identity provider
expiration = number # How many hours authenticated users can work before refresh
conditions = object({
claim = string # key value to evaluate the condition against.
operator = string # The operation to perform on the claim. Supported values are EQUALS, EQUALS_IGNORE_CASE, IN, NOT_EQUALS_IGNORE_CASE, NOT_EQUALS, and CONTAINS.
value = string # Value to be compared agains
})
})
)
)
account_management_policies = optional(list(string)) # A list of group access management roles to create.
invite_users = list(string) # Users to invite to the access group
})
)
This module creates a VPC in a resource group with optional Classic Access. It also allows users to update the default vpc security group with additional rules.
Default security group rules are converted from a list to an object to ensure that adding, deleting, or changing the order of rules listed will not force unwanted changes. Example:
ibm_is_security_group_rule.default_vpc_rule["allow-inbound-ping"]
ibm_is_security_group_rule.default_vpc_rule["allow-inbound-ssh"]
This module allows a user to optionally create public gateways in the VPC in each of the three zones of the VPC's region.
This module creates a network ACL with any number of rules. (Note: by default, VPC Network ACLs have a maximum of 50 rules.) Any subnets created by this module will be connected to this ACL. The following rules are automatically created in dynamic_acl_rules.tf.
These ACL rules will be automatically created for the VPC regardless of subnet CIDR blocks:
Direction | Rule | Allow / Deny | Protocol | Source | Source Port | Destination | Desination Port |
---|---|---|---|---|---|---|---|
Inbound | Allow Worker Nodes to be Created | Allow | All | 161.26.0.0/16 | - | 0.0.0.0/0 | - |
Inbound | Allow communication to Services over Private Service Endpoint | Allow | All | 166.8.0.0/14 | - | 0.0.0.0/0 | - |
Outbound | Allow Worker Nodes to be Created | Allow | All | 0.0.0.0/0 | - | 161.26.0.0/16 | - |
Outbound | Allow communication to Services over Private Service Endpoint | Allow | All | 0.0.0.0/0 | - | 166.8.0.0/14 | - |
The control pane ip module dynamicly creates ACL allow rules for the OpenShift Control Pane based on the region provided. Due to the maximum of 50 ACL rules, only inbound traffic allow rules are created. For this architecture, use a rule to allow all outbound traffic.
This module dynamically creates a rule to allow outbound traffic from and allow inbound traffic to each subnet created by the subnets
variable. This is an example of the rules created from the default value:
Direction | Allow / Deny | Protocol | Source | Source Port | Destination | Desination Port |
---|---|---|---|---|---|---|
Inbound | Allow | All | 10.10.10.0/24 | - | 0.0.0.0/0 | - |
Inbound | Allow | All | 10.20.10.0/24 | - | 0.0.0.0/0 | - |
Inbound | Allow | All | 10.30.10.0/24 | - | 0.0.0.0/0 | - |
Outbound | Allow | All | 0.0.0.0/0 | - | 10.10.10.0/24 | - |
Outbound | Allow | All | 0.0.0.0/0 | - | 10.20.10.0/24 | - |
Outbound | Allow | All | 0.0.0.0/0 | - | 10.30.10.0/24 | - |
The subnet module allows users to create subnets in 1, 2, or 3 zones. Public gateways can be optionally attached to each subnet.
A CIDR block is created in the VPC for each subnet that will be provisioned
The type of the subnets
variable is as follows:
object({
zone-1 = list(object({
name = string
cidr = string
public_gateway = optional(bool)
}))
zone-2 = list(object({
name = string
cidr = string
public_gateway = optional(bool)
}))
zone-3 = list(object({
name = string
cidr = string
public_gateway = optional(bool)
}))
})
While zone-1
, zone-2
, and zone-3
are all lists, these lists are converted into an object before the resources are provisioned. This ensures that the addition or deletion of subnets will affect only the added or deleted subnets. Example:
module.subnets.ibm_is_subnet.subnet["gcat-multizone-subnet-a"]
module.subnets.ibm_is_subnet.subnet["gcat-multizone-subnet-b"]
module.subnets.ibm_is_subnet.subnet["gcat-multizone-subnet-c"]
module.subnets.ibm_is_vpc_address_prefix.subnet_prefix["gcat-multizone-subnet-a"]
module.subnets.ibm_is_vpc_address_prefix.subnet_prefix["gcat-multizone-subnet-b"]
module.subnets.ibm_is_vpc_address_prefix.subnet_prefix["gcat-multizone-subnet-c"]
This module creates an IBM Cloud Object Stroage instance required for the creation of an OpenShift cluster.
This module creates a Red Hat OpenShift Cluster across all the subnets created for the VPC. This module can also dynamically create additional worker pools across the subnets.
The cluster resources can be found in the cluster folder.
Name | Type | Description | Sensitive | Default |
---|---|---|---|---|
ibmcloud_api_key | string | The IBM Cloud platform API key needed to deploy IAM enabled resources | true | |
TF_VERSION | string | The version of the Terraform engine that's used in the Schematics workspace. | 1.0 | |
prefix | string | A unique identifier need to provision resources. Must begin with a letter | gcat-multizone | |
region | string | Region where VPC will be created | us-south | |
resource_group | string | Name of resource group where all infrastructure will be provisioned | gcat-landing-zone-dev | |
access_groups | list( object({ name = string description = string policies = list( object({ name = string roles = list(string) resources = object({ resource_group = optional(string) resource_type = optional(string) service = optional(string) resource_instance_id = optional(string) }) }) ) dynamic_policies = optional( list( object({ name = string identity_provider = string expiration = number conditions = object({ claim = string operator = string value = string }) }) ) ) account_management_policies = optional(list(string)) invite_users = list(string) }) ) | A list of access groups to create | [ { name = "admin" description = "An example admin group" policies = [ { name = "admin_all" resources = { resource_group = "gcat-landing-zone-dev" } roles = ["Administrator","Manager"] } ] dynamic_policies = [] invite_users = [ "[email protected]" ] }, { name = "dev" description = "A developer access group" policies = [ { name = "dev_view_vpc" resources = { resource_group = "gcat-landing-zone-dev" service = "id" } roles = ["Viewer"] } ] invite_users = ["[email protected]"] } ] |
|
classic_access | bool | Enable VPC Classic Access. Note: only one VPC per region can have classic access | false | |
subnets | object({ zone-1 = list(object({ name = string cidr = string public_gateway = optional(bool) })) zone-2 = list(object({ name = string cidr = string public_gateway = optional(bool) })) zone-3 = list(object({ name = string cidr = string public_gateway = optional(bool) })) }) | List of subnets for the vpc. For each item in each array, a subnet will be created. | { zone-1 = [ { name = "subnet-a" cidr = "10.10.10.0/24" public_gateway = true } ], zone-2 = [ { name = "subnet-b" cidr = "10.20.10.0/24" public_gateway = true } ], zone-3 = [ { name = "subnet-c" cidr = "10.30.10.0/24" public_gateway = true } ] } |
|
use_public_gateways | object({ zone-1 = optional(bool) zone-2 = optional(bool) zone-3 = optional(bool) }) | Create a public gateway in any of the three zones with true . |
{ zone-1 = true zone-2 = true zone-3 = true } |
|
acl_rules | list( object({ name = string action = string destination = string direction = string source = string tcp = optional( object({ port_max = optional(number) port_min = optional(number) source_port_max = optional(number) source_port_min = optional(number) }) ) udp = optional( object({ port_max = optional(number) port_min = optional(number) source_port_max = optional(number) source_port_min = optional(number) }) ) icmp = optional( object({ type = optional(number) code = optional(number) }) ) }) ) | Access control list rule set | [ { name = "allow-all-inbound" action = "deny" direction = "inbound" destination = "0.0.0.0/0" source = "0.0.0.0/0" }, { name = "allow-all-outbound" action = "deny" direction = "outbound" destination = "0.0.0.0/0" source = "0.0.0.0/0" } ] |
|
security_group_rules | list( object({ name = string direction = string remote = string tcp = optional( object({ port_max = optional(number) port_min = optional(number) }) ) udp = optional( object({ port_max = optional(number) port_min = optional(number) }) ) icmp = optional( object({ type = optional(number) code = optional(number) }) ) }) ) | A list of security group rules to be added to the default vpc security group | [ { name = "allow-inbound-ping" direction = "inbound" remote = "0.0.0.0/0" icmp = { type = 8 } }, { name = "allow-inbound-ssh" direction = "inbound" remote = "0.0.0.0/0" tcp = { port_min = 22 port_max = 22 } }, ] |
|
machine_type | string | The flavor of VPC worker node to use for your cluster. Use ibmcloud ks flavors to find flavors for a region. |
bx2.4x16 | |
workers_per_zone | number | Number of workers to provision in each subnet | 2 | |
entitlement | string | If you purchased an IBM Cloud Cloud Pak that includes an entitlement to run worker nodes that are installed with OpenShift Container Platform, enter entitlement to create your cluster with that entitlement so that you are not charged twice for the OpenShift license. Note that this option can be set only when you create the cluster. After the cluster is created, the cost for the OpenShift license occurred and you cannot disable this charge. | cloud_pak | |
kube_version | string | Specify the Kubernetes version, including the major.minor version. To see available versions, run ibmcloud ks versions . |
4.7.23_openshift | |
wait_till | string | To avoid long wait times when you run your Terraform code, you can specify the stage when you want Terraform to mark the cluster resource creation as completed. Depending on what stage you choose, the cluster creation might not be fully completed and continues to run in the background. However, your Terraform code can continue to run without waiting for the cluster to be fully created. Supported args are MasterNodeReady , OneWorkerNodeReady , and IngressReady |
IngressReady | |
tags | list(string) | A list of tags to add to the cluster | [] | |
worker_pools | list(object({ name = string machine_type = string workers_per_zone = number })) | List of maps describing worker pools | [ { name = "dev" machine_type = "cx2.8x16" workers_per_zone = 2 }, { name = "test" machine_type = "mx2.4x32" workers_per_zone = 2 } ] |
Name | Description |
---|---|
access_groups | Access group information |
vpc_id | ID of VPC created |
acl_id | ID of ACL created for subnets |
public_gateways | Public gateways created |
subnet_ids | The IDs of the subnets |
subnet_detail_list | A list of subnets containing names, CIDR blocks, and zones. |
subnet_zone_list | A list containing subnet IDs and subnet zones |
cluster_id | ID of cluster created |
cluster_name | Name of cluster created |
cluster_private_service_endpoint_url | URL For Cluster Private Service Endpoint |
cluster_private_service_endpoint_port | Port for Cluster private service endpoint |
module landing_zone {
source = "./landing_zone"
prefix = var.prefix
region = var.region
resource_group = var.resource_group
access_groups = var.access_groups
classic_access = var.classic_access
subnets = var.subnets
use_public_gateways = var.use_public_gateways
acl_rules = var.acl_rules
security_group_rules = var.security_group_rules
machine_type = var.machine_type
workers_per_zone = var.workers_per_zone
entitlement = var.entitlement
kube_version = var.kube_version
wait_till = var.wait_till
tags = var.tags
worker_pools = var.worker_pools
}