VARIABLES.md

Config Module Input Variables

Input variables used in the config module are all defined in config/variables.tf:

Terraform Provider Variables

Variable Name	Description	Required	Default Value
tenancy_ocid	The OCI tenancy id where this configuration will be executed. This information can be obtained in OCI Console.	Yes	None
user_ocid	The OCI user id that will execute this configuration. This information can be obtained in OCI Console. The user must have the necessary privileges to provision the resources.	Yes	""
fingerprint	The user's public key fingerprint. This information can be obtained in OCI Console.	Yes	""
private_key_path	The local path to the user private key.	Yes	""
private_key_password	The private key password, if any.	No	""

Environment Variables

Variable Name	Description	Required	Default Value
region *	The tenancy region identifier where the Terraform should provision the resources.	Yes	None
service_label	A label used as a prefix for naming resources.	Yes	None
cis_level	Determines CIS OCI Benchmark Level to apply on Landing Zone managed resources. Level 1 is be practical and prudent. Level 2 is intended for environments where security is more critical than manageability and usability. Level 2 drives the creation of an OCI Vault, buckets encryption with a customer managed key, write logs for buckets and the usage of specific policies in Security Zones. For more information please review the CIS OCI Benchmark available here. Acceptable inputs are "1" or "2".	Yes	"2"
use_enclosing_compartment	A boolean flag indicating whether or not to provision the Landing Zone within an enclosing compartment other than the root compartment. When provisioning the Landing Zone as a narrower-permissioned user, make sure to set this variable value to true.	Yes	true
existing_enclosing_compartment_ocid	The OCID of a pre-existing enclosing compartment where Landing Zone compartments are to be created. If use_enclosing_compartment is false, the module creates the Landing Zone compartments in the root compartment as long as the executing user has the required permissions.	No	None
extend_landing_zone_to_new_region	Whether Landing Zone is being extended to another region. When set to true, compartments, groups, policies and resources at the home region are not provisioned. Use this when you want provision a Landing Zone in a new region, but reuse existing Landing Zone resources in the home region.	No	false
policies_in_root_compartment	The Landing Zone requires policies attached to the root compartment to work at full capacity. For instance, security administrators are expect to manage Cloud Guard, Tag Namespaces, Tag Defaults, Event Rules, and others. Likewise, IAM administrators are expected to manage IAM resources in general. Such capabilities are only enabled if policies are created at the root compartment, as they apply to the tenancy as a whole. A narrower-permissioned user will not likely have the permissions to create such policies. As a consequence, it is expected that these policies are previously created by a wide-permissioned user. Therefore, when provisioning the Landing Zone as a narrower-permissioned user, make sure to set this variable value to "USE", in which case permissions are not created at the root compartment. Default is "CREATE", meaning the module will provision the policies at the root compartment, as long as the executing user has the required permissions.	Yes	"CREATE"
enable_template_policies	Whether policies should be created based on metadata associated with compartments. This is an alternative way of managing policies, enabled by the CIS Landing Zone standalone IAM policy module. When set to true, the grants to resources belonging to a specific compartment are combined into a single policy that is attached to the compartment itself. This differs from the existing approach, where grants are combined per grantee and attached to the enclosing compartment.	No	false
existing_iam_admin_group_name	The name or OCID of an existing group for IAM administrators.	No	None
existing_cred_admin_group_name	The name or OCID of an existing group for credential administrators.	No	None
existing_security_admin_group_name	The name or OCID of an existing group for security administrators.	No	None
existing_network_admin_group_name	The name or OCID of an existing group for network administrators.	No	None
existing_appdev_admin_group_name	The name or OCID of an existing group for application development administrators.	No	None
existing_database_admin_group_name	The name or OCID of an existing group for database administrators.	No	None
existing_exainfra_admin_group_name	The name or OCID of an existing group for Exadata Cloud Service infrastructure administrators.	No	None
existing_auditor_group_name	The name or OCID of an existing group for auditors.	No	None
existing_announcement_reader_group_name	The name or OCID of an existing group for announcement readers.	No	None
existing_cost_admin_group_name	The name or OCID of an existing group for cost administrators.	No	None
existing_storage_admin_group_name	The name or OCID of an existing group for storage administrators.	No	None
existing_security_fun_dyn_group_name	The name of an existing dynamic group to be used by OCI Functions in the Security compartment.	No	None
existing_appdev_fun_dyn_group_name	The name of an existing dynamic group to be used by OCI Functions in the AppDev compartment.	No	None
existing_compute_agent_dyn_group_name	The name of an existing dynamic group to be used by Compute's management agent in the AppDev compartment.	No	None
existing_database_kms_dyn_group_name	The name of an existing dynamic group to be used by databases in the Database compartment to access OCI KMS Keys.	No	None

* For a list of available regions, please see https://docs.cloud.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm

Networking - Generic VCNs Variables

Variable Name	Description	Required	Default Value
vcn_cidrs	List of CIDR blocks for the VCNs to be created in CIDR notation. If hub_spoke_architecture is true, these VCNs are turned into spoke VCNs.	No	["10.0.0.0/20"]
vcn_names	List of custom names to be given to the VCNs, overriding the default VCN names (service_label-index-vcn). The list length and elements order must match vcn_cidrs'.	No	[]
subnets_names	List of custom names to be used in each of the spoke(s) subnet names, the first subnet will be public if var.no_internet_access is false. Overriding the default subnet names (service_label-index-web-subnet). The list length and elements order must match subnets_sizes.	No	[]
subnets_sizes	List of subnet sizes in bits that will be added to the VCN CIDR size. Overriding the default subnet size of VCN CIDR + 4. The list length and elements order must match subnets_names.	No	[]

Networking - Exadata Cloud Service VCNs Variables

Variable Name	Description	Required	Default Value
exacs_vcn_cidrs	List of CIDR blocks for the Exadata VCNs, in CIDR notation. Each provided CIDR relates to one and only one VCN. Be mindful about Exadata Requirements for IP Address Space in OCI documentation. You can provide up to nine CIDRs.	No	[]
exacs_vcn_names	List of Exadata VCNs custom names, overriding the default Exadata VCNs names. Each provided name relates to one and only one VCN, the nth value applying to the nth value in exacs_vcn_cidrs. You can provide up to nine names.	No	[]
exacs_client_subnet_cidrs	List of CIDR blocks for the client subnets of Exadata Cloud Service VCNs, in CIDR notation. Each provided CIDR value relates to one and only one VCN, the nth value applying to the nth value in exacs_vcn_cidrs. CIDRs must not overlap with 192.168.128.0/20. You can provide up to nine CIDRs.	No	[]
exacs_backup_subnet_cidrs	List of CIDR blocks for the backup subnets of Exadata Cloud Service VCNs, in CIDR notation. Each provided CIDR value relates to one and only one VCN, the nth value applying to the nth value in exacs_vcn_cidrs. CIDRs must not overlap with 192.168.128.0/20. You can provide up to nine CIDRs.	No	[]
deploy_exainfra_cmp	Whether a compartment for Exadata infrastructure should be created. If false, Exadata infrastructure should be created in the database compartment.	No	false

Networking - Hub/Spoke Variables

Variable Name	Description	Required	Default Value
hub_spoke_architecture	Determines if Hub/Spoke network architecture is to be deployed. Allows for inter-spoke routing through a DRG. If set to rue, either a new DRG is deployed or an existing DRG can be reused (if you provide its OCID in existing_drg_id variable.) With Hub/Spoke, all VCNs (Generic and ExaCS) are peered through the DRG.	No	false
dmz_vcn_cidr	IP range for the DMZ VCN in CIDR notation. DMZ VCNs are commonly used for network appliance deployments. All traffic will be routed through the DMZ VCN.	No	""
dmz_for_firewall	Determines if a 3rd party firewall will be deployed in the DMZ VCN. DRG attachments are not created.	No	false
dmz_number_of_subnets	The number of subnets to be created in the DMZ VCN. If using the DMZ VCN for a network appliance deployment, please see the vendor's documentation or OCI reference architecture to determine the number of subnets required.	Yes, if dmz_vcn_cidr is provided	2
dmz_subnet_size	The number of additional bits with which to extend the DMZ VCN CIDR prefix. For instance, if dmz_vcn_cidr's prefix is 20 (/20) and dmz_subnet_size is 4, subnets are going to be /24.	Yes, if dmz_vcn_cidr is provided	4

Networking - Public Connectivity Variables

Variable Name	Description	Required	Default Value
no_internet_access	Determines if the VCNs are directly connected to the Internet. If false, an Internet Gateway and NAT Gateway are created for Internet connectivity. If true, Internet Gateway and NAT Gateway are NOT created. In this case, it is recommended to set is_vcn_onprem_connected to true and provide values to onprem_cidrs, or your OCI network will not have any entry points.	No	false
public_src_bastion_cidrs	List of external IP ranges in CIDR notation allowed to make SSH and RDP inbound connections to bastion servers that are eventually deployed in public subnets. 0.0.0.0/0 is not allowed in the list.	No	[]
public_src_lbr_cidrs	List of external IP ranges in CIDR notation allowed to make HTTPS inbound connections to a Load Balancer that is eventually deployed.	No	[]
public_dst_cidrs	List of external IP ranges in CIDR notation for HTTPS outbound connections. Applies to connections made over NAT Gateway.	No	[]

Networking - Connectivity to On-Premises Variables

Variable Name	Description	Required	Default Value
is_vcn_onprem_connected	Whether the VCNs are connected to the on-premises network, in which case a DRG is attached to the VCNs. If set to true, either a new DRG is deployed or an existing DRG can be reused (if you provide its OCID in existing_drg_id variable.	No	false
onprem_cidrs	List of on-premises CIDR blocks allowed to connect to the Landing Zone network via a DRG. The blocks are added to route rules and NSGs. If no_internet_access is true it's advised to provide values for onprem_cidrs, or your OCI network will not have any entry points.	No	[]
onprem_src_ssh_cidrs	List of on-premises IP ranges allowed to make SSH and RDP inbound connections.	No	[]

Networking - DRG (Dynamic Routing Gateway)

Variable Name	Description	Required	Default Value
existing_drg_id	The OCID of an existing DRG, used in Hub/Spoke and when connecting to On-Premises network. Provide a value if you do NOT want the Landing Zone to deploy a new DRG.	No	""

Notifications Alarms and Events Variables

Variable Name	Description	Required	Default Value
security_admin_email_endpoints	A list of email addresses to receive notifications for security related events. If extending Landing Zone to a new region, this is ignored.	Yes	None
network_admin_email_endpoints	A list of email addresses to receive notifications for network related events. If extending Landing Zone to a new region, this is ignored.	Yes	None
storage_admin_email_endpoints	List of email addresses for all storage related notifications. If no email addresses are provided, then the topic, events and alarms associated with storage are not created.	No	None
compute_admin_email_endpoints	List of email addresses for all compute related notifications. If no email addresses are provided, then the topic, events and alarms associated with compute are not created.	No	None
budget_admin_email_endpoints	List of email addresses for all budget related notifications. If no email addresses are provided, then the topic, events and alarms associated with governance are not created.	No	None
database_admin_email_endpoints	List of email addresses for all database related notifications. If no email addresses are provided, then the topic, events and alarms associated with database are not created.	No	None
exainfra_admin_email_endpoints	List of email addresses for all Exadata infrastructure related notifications. If no email addresses are provided, then the topic, and alarms associated with Exadata infrastructure are not created. If deploy_exainfra_cmp is false, then Exadata events are created in the database compartment and sent to the database topic.	No	None
create_alarms_as_enabled	Creates alarm artifacts in disabled state when set to False.	No	False
create_events_as_enabled	Creates event rules artifacts in disabled state when set to False.	No	False
alarm_message_format	Format of the message sent by alarms.	No	PRETTY_JSON

Object Storage Bucket Variables

Variable Name	Description	Required	Default Value
enable_oss_bucket	Whether an Object Storage bucket should be enabled. If true, the bucket is managed in the application (AppDev) compartment.	No	true
existing_bucket_vault_compartment_id	The OCID of an existing compartment for the vault with the key used in Object Storage bucket encryption.	No	null
existing_bucket_vault_id	The OCID of an existing vault for the key used in Object Storage bucket encryption.	No	null
existing_bucket_key_id	The OCID of an existing key used in Object Storage bucket encryption.	No	null

Cloud Guard Variables

Variable Name	Description	Required	Default Value
enable_cloud_guard	Determines whether the Cloud Guard service should be enabled. If true, Cloud Guard is enabled and the Root compartment is configured with a Cloud Guard target, as long as there is no pre-existing Cloud Guard target for the Root compartment (or target creation will fail). Keep in mind that once you set this to true, Cloud Guard target is managed by Landing Zone. If later on you switch this to false, the managed target is deleted and all (open, resolved and dismissed) problems associated with the deleted target are being moved to 'deleted' state. This operation happens in the background and would take some time to complete. Deleted problems can be viewed from the problems page using the 'deleted' status filter. For more details on Cloud Guard problems lifecycle, see the documentation. If Cloud Guard is already enabled and a target exists for the Root compartment, set this variable to false.	No	true
enable_cloud_guard_cloned_recipes	Determines whether cloned recipes are attached to the managed Cloud Guard target. If false, Oracle managed recipes are attached.	No	false
cloud_guard_reporting_region	The Cloud Guard reporting region, where Cloud Guard reporting resources are kept. If not set, it is internally defaulted to home region.	No	null
cloud_guard_risk_level_threshold	Determines the minimum Risk level that triggers sending Cloud Guard problems to the defined Cloud Guard Email Endpoint. E.g. a setting of High will send notifications for Critical and High problems.	No	High
cloud_guard_admin_email_endpoints	List of email addresses for Cloud Guard related notifications. If no email addresses are provided, then the topic and event rules are not created.	No	None

Security Zones Variables

Variable Name	Description	Required	Default Value
enable_security_zones	Determines if Security Zones are enabled in Landing Zone compartment(s). If true, Security Zones recipe(s) are created and a Security Zone with that recipe is enabled for the enclosing compartment. The Security Zone is only enabled if an enclosing compartment is used.	No	false
sz_security_policies	List of Security Zones policy OCIDs that will be added to the Security Zones recipe. These policies are added to the Security Zone policies associated to the selected cis_level. If cis_level is "1", "deny public_buckets" and "deny db_instance_public_access" policies are added. If cis_level is "2", "deny block_volume_without_vault_key", "deny boot_volume_without_vault_key", "deny buckets_without_vault_key", and "deny file_system_without_vault_key" policies are further added. To get a Security Zone policy OCID use the oci cli: oci cloud-guard security-policy-collection list-security-policies --compartment-id <tenancy-ocid>	No	[]

Logging Variables

Variable Name	Description	Required	Default Value
enable_service_connector	Whether Service Connector Hub should be enabled. If true, a single Service Connector is managed for all services log sources and the designated target specified in service_connector_target_kind. The Service Connector is created in INACTIVE state.	No	false
activate_service_connector	Whether Service Connector Hub should be activated. If true, costs my incur due to usage of Object Storage bucket, Streaming or Function.	No	false
service_connector_target_kind	Service Connector Hub target resource. Valid values are objectstorage, streaming, functions or logginganalytics. In case of objectstorage, a new bucket is created. In case of streaming, you can provide an existing stream ocid in existing_service_connector_target_stream_id and that stream is used. If no ocid is provided, a new stream is created. In case of functions, you must provide the existing function ocid in existing_service_connector_target_function_id. In case of logginganalytics, a log group for Logging Analytics service is created and the service is enabled if not already."	No	objectstorage
existing_service_connector_bucket_vault_compartment_id	The OCID of an existing compartment for the vault with the key used in Service Connector target Object Storage bucket encryption. Only applicable if service_connector_target_kind is set to objectstorage.	No	null
existing_service_connector_bucket_vault_id	The OCID of an existing vault for the encryption key used in Service Connector target Object Storage bucket. Only applicable if service_connector_target_kind is set to objectstorage.	No	null
existing_service_connector_bucket_key_id	The OCID of an existing encryption key used in Service Connector target Object Storage bucket. Only applicable if service_connector_target_kind is set to objectstorage.	No	null
existing_service_connector_target_stream_id	The OCID of an existing stream to be used as the Service Connector target. Only applicable if service_connector_target_kind is set to streaming.	No	null
existing_service_connector_target_function_id	The OCID of an existing function to be used as the Service Connector target. Only applicable if service_connector_target_kind is set to functions.	No	null

Scanning Variables

Variable Name	Description	Required	Default Value
vss_create	Whether Vulnerability Scanning Service (VSS) recipes and targets are enabled in the Landing Zone.	No	false
vss_scan_schedule	The scan schedule for the VSS recipe, if enabled. Valid values are WEEKLY or DAILY.	No	"WEEKLY"
vss_scan_day	The week day for the VSS recipe, if enabled. Only applies if vss_scan_schedule is WEEKLY.	No	"SUNDAY"
vss_port_scan_level	The port scan level. Valid values are STANDARD, LIGHT or NONE. STANDARD checks the 1000 most common port numbers, LIGHT checks the 100 most common port numbers, NONE does not check for open ports.	No	"STANDARD"
vss_agent_scan_level	The level for agent-based scans. Valid values: STANDARD, NONE. STANDARD enables agent-based scanning. NONE disables agent-based scanning and moots any agent related attributes.	No	"STANDARD"
vss_agent_cis_benchmark_settings_scan_level	Valid values: STRICT, MEDIUM, LIGHTWEIGHT, NONE. STRICT: If more than 20% of the CIS benchmarks fail, then the target is assigned a risk level of Critical. MEDIUM: If more than 40% of the CIS benchmarks fail, then the target is assigned a risk level of High. LIGHTWEIGHT: If more than 80% of the CIS benchmarks fail, then the target is assigned a risk level of High. NONE: disables CIS benchmark scanning.	No	"MEDIUM"
vss_enable_file_scan	Whether file scanning is enabled. Only applies if vss_agent_scan_level is not NONE.	No	false
vss_folders_to_scan	A list of folders to scan. Only applies if vss_enable_file_scan is true. Currently, the Scanning service checks for vulnerabilities only in log4j and spring4shell.	No	["/"]

KMS Variables

Variable Name	Description	Required	Default Value
existing_key_id	The OCID of an existing key to be used for Object Storage bucket encryption. If not provided, a new key is created.	No	""
existing_key_compartment_id	The compartment OCID of the provided existing key.	No	""

Budget Variables

Variable Name	Description	Required	Default Value
create_budget	If checked, a budget will be created at the root or enclosing compartment and based on forecast spend.	No	false
budget_alert_threshold	The threshold for triggering the alert expressed as a percentage of the monthly forecast spend.	No	100%
budget_amount	The amount of the budget expressed as a whole number in the currency of the customer's rate card.	No	1000
budget_alert_email_endpoints	List of email addresses for budget alerts. (Type an email address and hit enter to enter multiple values)	No	None

Pre-Config Module Input Variables

Input variables used in the pre-config module are all defined in pre-config/variables.tf:

Variable Name	Description	Required	Default Value
unique_prefix	A label that gets prefixed to all default resource names created by the module.	No	None
enclosing_compartment_names	A list of compartment names that will hold the Landing Zone compartments. If no compartment name is given, the module creates one compartment with a default name ending in -top-cmp.	No	"unique_prefix-top-cmp" or "lz-top-cmp"
existing_enclosing_compartments_parent_ocid	the parent compartment ocid of the top compartment, indicating where to insert the enclosing compartment in the hierarchy. Remember that OCI has a max six level compartment hierarchy. If you create the enclosing compartment at level five, the Landing Zone compartments will be at level six and adding sub-compartments to Landing Zone compartments will not be possible.	No	tenancy_ocid
use_existing_provisioning_group	A boolean flag indicating whether or not an existing group will be used for Landing Zone provisioning. If false, one group is created for each compartment defined by enclosing_compartment_names variable.	No	false
existing_provisioning_group_name(*)	The name of an existing group to be used for provisioning all resources in the compartments defined by enclosing_compartment_names variable. Ignored if use_existing_provisioning_group is false.	No	None
grant_services_policies	Whether services policies should be granted. If these policies already exist in the root compartment, set it to false for avoiding policies duplication. Useful if the module is reused across distinct stacks or configurations.	No	true
use_existing_groups	A boolean flag indicating whether or not existing groups are to be reused for Landing Zone. If false, one set of groups is created for each compartment defined by enclosing_compartment_names variable. If true, existing group names must be provided and this single set will be able to manage resources in all enclosing compartments. It does not apply to dynamic groups.	No	false
existing_iam_admin_group_name	The name or OCID of an existing group for IAM administrators.	Yes, if use_existing_groups is true.	None
existing_cred_admin_group_name	The name or OCID of an existing group for credential administrators.	Yes, if use_existing_groups is true.	None
existing_security_admin_group_name	The name or OCID of an existing group for security administrators.	Yes, if use_existing_groups is true.	None
existing_network_admin_group_name	The name or OCID of an existing group for network administrators.	Yes, if use_existing_groups is true.	None
existing_appdev_admin_group_name	The name or OCID of an existing group for application development administrators.	Yes, if use_existing_groups is true.	None
existing_database_admin_group_name	The name or OCID of an existing group for database administrators.	Yes, if use_existing_groups is true.	None
existing_exainfra_admin_group_name	The name or OCID of an existing group for Exadata Cloud Service infrastructure administrators.	No	None
existing_auditor_group_name	The name or OCID of an existing group for auditors.	Yes, if use_existing_groups is true.	None
existing_announcement_reader_group_name	The name or OCID of an existing group for announcement readers.	Yes, if use_existing_groups is true.	None
existing_cost_admin_group_name	The name or OCID of an existing group for cost management administrators.	Yes, if use_existing_groups is true.	None
existing_security_fun_dyn_group_name	The name of an existing dynamic group to be used by OCI Functions in the Security compartment.	No	None
existing_appdev_fun_dyn_group_name	The name of an existing dynamic group to be used by OCI Functions in the AppDev compartment.	No	None
existing_compute_agent_dyn_group_name	The name of an existing dynamic group to be used by Compute's management agent in the AppDev compartment.	No	None
existing_database_kms_dyn_group_name	The name of an existing dynamic group to be used by databases in the Database compartment to access OCI KMS Keys.	No	None

(*) A user with an API key must be assigned to the provisioning group. The module does not create or assign the user.