|
| 1 | +## auto.tfvars syntax for Governance Module |
| 2 | +These are the syntax and sample format for providing inputs to the modules via <b>*.auto.tfvars</b> files. |
| 3 | +<b>"key"</b> must be unique to every resource that is created. |
| 4 | +Comments preceed with <b>##</b>. |
| 5 | + |
| 6 | +## TAGS |
| 7 | +1. Tag Namespaces |
| 8 | +- <b>Syntax</b> |
| 9 | + |
| 10 | + ```` |
| 11 | + tag_namespaces = { |
| 12 | + ## key - Is a unique value to reference the resources respectively |
| 13 | + key = { |
| 14 | + # Required |
| 15 | + compartment_id = string |
| 16 | + description = string |
| 17 | + name = string |
| 18 | + |
| 19 | + # Optional |
| 20 | + defined_tags = map |
| 21 | + freeform_tags = map |
| 22 | + is_retired = boolean |
| 23 | + }, |
| 24 | + } |
| 25 | + ```` |
| 26 | +- <b>Example</b> |
| 27 | + ```` |
| 28 | + ############################ |
| 29 | + # Governance |
| 30 | + # Create Tag Namespaces |
| 31 | + # Allowed Values: |
| 32 | + # compartment_id can be the ocid or the name of the compartment hierarchy delimited by double hiphens "--" |
| 33 | + # Example : compartment_id = "ocid1.compartment.oc1..aaaaaaaahwwiefb56epvdlzfic6ah6jy3xf3c" or compartment_id = "Network-root-cpt--Network" where "Network-root-cpt" is the parent of "Network" compartment |
| 34 | + ############################ |
| 35 | + tag_namespaces = { |
| 36 | + ArchitectureCenter--cis-oci-landing-zone-quickstart-managed = { |
| 37 | + # Required |
| 38 | + compartment_id = "root" |
| 39 | + description = "CIS Landing Zone tag namespace for OCI Architecture Center." |
| 40 | + name = "ArchitectureCenter\\cis-oci-landing-zone-quickstart-managed" |
| 41 | + }, |
| 42 | + Oracle-Tags = { |
| 43 | + # Required |
| 44 | + compartment_id = "root" |
| 45 | + description = "The namespace for the automatic tags." |
| 46 | + name = "Oracle-Tags" |
| 47 | + }, |
| 48 | + OracleInternalReserved = { |
| 49 | + # Required |
| 50 | + compartment_id = "root" |
| 51 | + description = "Oracle Internal Reserved Tags for workload classification" |
| 52 | + name = "OracleInternalReserved" |
| 53 | + }, |
| 54 | + } |
| 55 | + ```` |
| 56 | + |
| 57 | +
|
| 58 | +2. Tag Keys |
| 59 | +- <b>Syntax</b> |
| 60 | + |
| 61 | + ```` |
| 62 | + tag_keys = { |
| 63 | + ## key - Is a unique value to reference the resources respectively |
| 64 | + key = { |
| 65 | + # Required |
| 66 | + tag_namespace_id = string |
| 67 | + description = string |
| 68 | + name = string |
| 69 | + |
| 70 | + # Optional |
| 71 | + defined_tags = map |
| 72 | + freeform_tags = map |
| 73 | + is_cost_tracking = boolean |
| 74 | + is_retired = boolean |
| 75 | + validator = { |
| 76 | + validator_type = string |
| 77 | + validator_values = list |
| 78 | + } |
| 79 | + }, |
| 80 | + } |
| 81 | + ```` |
| 82 | +- <b>Example</b> |
| 83 | + ```` |
| 84 | + ############################ |
| 85 | + # Governance |
| 86 | + # Create Tag Keys |
| 87 | + # Allowed Values: |
| 88 | + # tag_namespace_id can be the ocid or the key of tag_namespaces (map) |
| 89 | + ############################ |
| 90 | + tag_keys = { |
| 91 | + ArchitectureCenter--cis-oci-landing-zone-quickstart-managed_release = { |
| 92 | + tag_namespace_id = "ArchitectureCenter--cis-oci-landing-zone-quickstart-managed" |
| 93 | + description = "CIS Landing Zone tag for OCI Architecture Center." |
| 94 | + name = "release" |
| 95 | + is_cost_tracking = false |
| 96 | + }, |
| 97 | + Oracle-Tags_CreatedBy = { |
| 98 | + tag_namespace_id = "Oracle-Tags" |
| 99 | + description = "The name of the principal that created the resource." |
| 100 | + name = "CreatedBy" |
| 101 | + is_cost_tracking = true |
| 102 | + }, |
| 103 | + Oracle-Tags_CreatedOn = { |
| 104 | + tag_namespace_id = "Oracle-Tags" |
| 105 | + description = "The date and time that the resource was created." |
| 106 | + name = "CreatedOn" |
| 107 | + is_cost_tracking = false |
| 108 | + }, |
| 109 | + Oracle-Tags_TestTag = { |
| 110 | + tag_namespace_id = "Oracle-Tags" |
| 111 | + description = "test" |
| 112 | + name = "TestTag" |
| 113 | + is_cost_tracking = false |
| 114 | + validator = [{ |
| 115 | + validator_type = "ENUM" |
| 116 | + validator_values = ["hey hi","my tag","value 1"] |
| 117 | + }] |
| 118 | + }, |
| 119 | + } |
| 120 | + ```` |
| 121 | + |
| 122 | +
|
| 123 | +3. Tag Defaults |
| 124 | + - <b>Syntax</b> |
| 125 | + |
| 126 | + ```` |
| 127 | + tag_defaults = { |
| 128 | + ## key - Is a unique value to reference the resources respectively |
| 129 | + key = { |
| 130 | + # Required |
| 131 | + compartment_id = string |
| 132 | + tag_definition_id = string |
| 133 | + value = string |
| 134 | + |
| 135 | + # Optional |
| 136 | + is_required = bool |
| 137 | + } |
| 138 | + } |
| 139 | + |
| 140 | + ```` |
| 141 | +- <b>Example</b> |
| 142 | + ```` |
| 143 | + ############################ |
| 144 | + # Governance |
| 145 | + # Create Default Tags |
| 146 | + # Allowed Values: |
| 147 | + # tag_definition_id can be the ocid or the key of tag_definitions (map) |
| 148 | + # compartment_id can be the ocid or the name of the compartment hierarchy delimited by double hiphens "--" |
| 149 | + # Example : compartment_id = "ocid1.compartment.oc1..aaaaaaaahwwiefb56epvdlzfic6ah6jy3xf3c" or compartment_id = "Network-root-cpt--Network" where "Network-root-cpt" is the parent of "Network" compartment |
| 150 | + ######################################################## |
| 151 | + tag_defaults = { |
| 152 | + Oracle-Tags_CreatedBy_root-default = { |
| 153 | + # Required |
| 154 | + tag_definition_id = "Oracle-Tags_CreatedBy" |
| 155 | + compartment_id = "root" |
| 156 | + value = "$${iam.principal.name}" |
| 157 | + }, |
| 158 | + Oracle-Tags_CreatedOn_root-default = { |
| 159 | + # Required |
| 160 | + tag_definition_id = "Oracle-Tags_CreatedOn" |
| 161 | + compartment_id = "root" |
| 162 | + value = "$${oci.datetime}" |
| 163 | + }, |
| 164 | + } |
| 165 | + ```` |
| 166 | +
|
| 167 | +## Billing |
| 168 | +4. Budgets |
| 169 | +- <b>Syntax</b> |
| 170 | +
|
| 171 | + ```` |
| 172 | + budgets = { |
| 173 | + ## key - Is a unique value to reference the resources respectively |
| 174 | + key = { |
| 175 | + #Required |
| 176 | + amount = string |
| 177 | + compartment_id = string |
| 178 | + reset_period = string |
| 179 | + |
| 180 | + #Optional |
| 181 | + budget_processing_period_start_offset = number |
| 182 | + defined_tags = map |
| 183 | + description = string |
| 184 | + display_name = string |
| 185 | + freeform_tags = map |
| 186 | + processing_period_type = string |
| 187 | + target_type = string |
| 188 | + targets = list |
| 189 | + }, |
| 190 | + } |
| 191 | + ```` |
| 192 | +- <b>Example</b> |
| 193 | + ```` |
| 194 | + // Copyright (c) 2021, 2022, Oracle and/or its affiliates. |
| 195 | + ############################ |
| 196 | + # Governance |
| 197 | + # Create Budgets |
| 198 | + # Allowed Values: |
| 199 | + # compartment_id can be the ocid or the name of the compartment hierarchy delimited by double hiphens "--" |
| 200 | + # Example : compartment_id = "ocid1.compartment.oc1..aaaaaaaahwwiefb56epvdlzfic6ah6jy3xf3c" or compartment_id = "Network-root-cpt--Network" where "Network-root-cpt" is the parent of "Network" compartment |
| 201 | + # processing_period_type : Valid values are INVOICE and MONTH. |
| 202 | + # target_type : Valid values are COMPARTMENT and TAG |
| 203 | + # targets : list of compartment OCIDs or list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}" |
| 204 | + ############################ |
| 205 | + budgets = { |
| 206 | + CD3-main-budget = { |
| 207 | + compartment_id = "root" |
| 208 | + amount = 10 |
| 209 | + reset_period = "MONTHLY" |
| 210 | + description = "Tracks spending from the root compartment and down" |
| 211 | + budget_processing_period_start_offset = "1" |
| 212 | + display_name = "CD3-main-budget" |
| 213 | + target_type = "COMPARTMENT" |
| 214 | + targets = ["root"] |
| 215 | + }, |
| 216 | + } |
| 217 | + |
| 218 | + ```` |
| 219 | +5. Alert Rule |
| 220 | +- <b>Syntax</b> |
| 221 | + ```` |
| 222 | + budget_alert_rules = { |
| 223 | + ## key - Is a unique value to reference the resources respectively |
| 224 | + key = { |
| 225 | + #Required |
| 226 | + budget_id = string |
| 227 | + threshold = string |
| 228 | + threshold_type = string |
| 229 | + type = string |
| 230 | + |
| 231 | + #Optional |
| 232 | + defined_tags = map |
| 233 | + description = string |
| 234 | + display_name = string |
| 235 | + freeform_tags = map |
| 236 | + message = string |
| 237 | + recipients = string |
| 238 | + }, |
| 239 | + } |
| 240 | + ```` |
| 241 | +- <b>Example</b> |
| 242 | + ```` |
| 243 | + // Copyright (c) 2021, 2022, Oracle and/or its affiliates. |
| 244 | + ############################ |
| 245 | + # Governance |
| 246 | + # Create Budget Alert Rules |
| 247 | + # Allowed Values: |
| 248 | + # compartment_id can be the ocid or the name of the compartment hierarchy delimited by double hiphens "--" |
| 249 | + # Example : compartment_id = "ocid1.compartment.oc1..aaaaaaaahwwiefb56epvdlzfic6ah6jy3xf3c" or compartment_id = "Network-root-cpt--Network" where "Network-root-cpt" is the parent of "Network" compartment |
| 250 | + ############################ |
| 251 | + budget_alert_rules = { |
| 252 | + CD3-main-budget_alert_rule = { |
| 253 | + budget_id = "CD3-main-budget" |
| 254 | + type = "FORECAST" |
| 255 | + threshold = "50" |
| 256 | + threshold_type = "PERCENTAGE" |
| 257 | + description = "Budget Alert Rule" |
| 258 | + display_name = "CD3-main-budget_alert_rule" |
| 259 | + }, |
| 260 | + } |
| 261 | + ```` |
0 commit comments