Merge pull request #5 from oracle-quickstart/release-0.1.4

Release 0.1.4

RELEASE-NOTES.md

@@ -1,3 +1,16 @@
+# February 28, 2024 Release Notes - 0.1.4
+
+## Updates
+
+### Events Module
+1. Networking events updated:
+    - Delete event for Local Peering Gateway renamed to *com.oraclecloud.virtualnetwork.deletelocalpeeringgateway.end*.
+    - Event *com.oraclecloud.servicegateway.deleteservicegateway.begin* removed.
+2. The reserved key "TENANCY-ROOT" has been introduced. It is used for referring to the root compartment OCID and can be assigned to *default_compartment_id* and *compartment_id* and *metric_compartment_id* attributes.
+
+### Alarms Module
+1. The reserved key "TENANCY-ROOT" has been introduced. It is used for referring to the root compartment OCID and can be assigned to *default_compartment_id* and *compartment_id* attributes.
+
 # January 10, 2024 Release Notes - 0.1.3
 
 ## Added

alarms/README.md

@@ -82,7 +82,7 @@ For referring to a specific module version, append *ref=\<version\>* to the *sou
 ## <a name="functioning">Module Functioning</a>
 
 In this module, alarms are defined using the *alarms_configuration* object, that supports the following attributes:
-- **default_compartment_id**: the default compartment for all resources managed by this module. It can be overriden by *compartment_id* attribute in each resource. This attribute is overloaded. It can be assigned either a literal OCID or a reference (a key) to an OCID.
+- **default_compartment_id**: the default compartment for all resources managed by this module. It can be overriden by *compartment_id* attribute in each resource. This attribute is overloaded. It can be assigned either a literal OCID or a reference (a key) to an OCID. The reserved key "TENANCY-ROOT" references the root compartment OCID. When "TENANCY-ROOT" is utilized, variable *tenancy_ocid* is required.
 - **default_defined_tags**: the default defined tags that are applied to all resources managed by this module. It can be overriden by *defined_tags* attribute in each resource.
 - **default_freeform_tags**: the default freeform tags that are applied to all resources managed by this module. It can be overriden by *freeform_tags* attribute in each resource.
 - **alarms**: define the alarms to capture and where to send them. 

alarms/SPEC.md

@@ -32,6 +32,7 @@ No modules.
 | <a name="input_enable_output"></a> [enable\_output](#input\_enable\_output) | Whether Terraform should enable the module output. | `bool` | `true` | no |
 | <a name="input_module_name"></a> [module\_name](#input\_module\_name) | The module name. | `string` | `"alarms"` | no |
 | <a name="input_streams_dependency"></a> [streams\_dependency](#input\_streams\_dependency) | A map of objects containing the externally managed streams this module may depend on. All map objects must have the same type and must contain at least an 'id' attribute (representing the topic OCID) of string type. | `map(any)` | `null` | no |
+| <a name="input_tenancy_ocid"></a> [tenancy\_ocid](#input\_tenancy\_ocid) | The tenancy OCID | `string` | `null` | no |
 | <a name="input_topics_dependency"></a> [topics\_dependency](#input\_topics\_dependency) | A map of objects containing the externally managed topics this module may depend on. All map objects must have the same type and must contain at least an 'id' attribute (representing the topic OCID) of string type. | `map(any)` | `null` | no |
 
 ## Outputs

alarms/examples/external-dependency/README.md

@@ -18,11 +18,11 @@ Note: *<bucket-name>* is the bucket specified by *oci_shared_config_bucket* vari
 1. Rename *input.auto.tfvars.template* to *\<project-name\>.auto.tfvars*, where *\<project-name\>* is any name of your choice.
 
 2. Within *\<project-name\>.auto.tfvars*, provide tenancy connectivity information and adjust the *alarms_configuration* input variable, by making the appropriate substitutions:
-   - Replace *\<REPLACE-BY-COMPARTMENT-REFERENCE\>* placeholders by the appropriate compartment references, expected to be found in the OCI Object Storage object specified by *oci_compartments_object*.
+   - Replace *\<REPLACE-BY-COMPARTMENT-REFERENCE\>* placeholders by the appropriate compartment references, expected to be found in the OCI Object Storage object specified by *oci_compartments_object*. Or utilize the reserved key "TENANCY-ROOT" for the root compartment OCID.
    - Replace *\<REPLACE-BY-TOPIC-REFERENCE\>* placeholders by the appropriate topic references, expected to be found in the OCI Object Storage object specified by *oci_topics_object*.
    - Replace *\<REPLACE-BY-BUCKET-NAME\>* placeholder by the OCI Object Storage bucket for configuration sharing across modules.
-   - Replace *\<REPLACE-BY-OBJECT-NAME-FOR-COMPARTMENTS\>* placeholder by the OCI Object Storage object with the compartments references. This object is tipically stored in OCI Object Storage by the module that manages compartments.
-   - Replace *\<REPLACE-BY-OBJECT-NAME-FOR-TOPICS\>* placeholder by the OCI Object Storage object to hold topic references. This object is tipically stored in OCI Object Storage by the module that manages topics.
+   - Replace *\<REPLACE-BY-OBJECT-NAME-FOR-COMPARTMENTS\>* placeholder by the OCI Object Storage object with the compartments references. This object is typically stored in OCI Object Storage by the module that manages compartments.
+   - Replace *\<REPLACE-BY-OBJECT-NAME-FOR-TOPICS\>* placeholder by the OCI Object Storage object to hold topic references. This object is typically stored in OCI Object Storage by the module that manages topics.
 
 Refer to [Alarms' module README.md](../../README.md) for overall attributes usage.
 

alarms/examples/external-dependency/input.auto.tfvars.template

@@ -1,27 +1,27 @@
 # Copyright (c) 2023 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
-#--------------------------------------------------------------------------------------------------------------------------------------------------
+#------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 # 1. Rename this file to <project-name>.auto.tfvars, where <project-name> is a name of your choice.
 # 2. Provide values for "Tenancy Connectivity Variables".
 # 3. Replace <REPLACE-BY-COMPARTMENT-REFERENCE> placeholders by the appropriate compartment references, 
-#    expected to be found in the OCI Object Storage object specified in oci_compartments_dependency.
+#    expected to be found in the OCI Object Storage object specified in oci_compartments_dependency. Or utilize the reserved key "TENANCY-ROOT" for the root compartment OCID.
 # 4. Replace <REPLACE-BY-TOPIC-REFERENCE> placeholders by the appropriate topic references, 
 #    expected to be found in the OCI Object Storage object specified in oci_topics_dependency.
 # 5. Replace <REPLACE-BY-BUCKET-NAME> placeholder by the OCI Object Storage bucket for configuration sharing across modules.
 # 6. Replace <REPLACE-BY-OBJECT-NAME-FOR-COMPARTMENTS> placeholder by the OCI Object Storage object with the compartments references. This 
 #    object is tipically stored in OCI Object Storage by the module that manages compartments.
 # 7. Replace <REPLACE-BY-OBJECT-NAME-FOR-TOPICS> placeholder by the OCI Object Storage object to with the topic references. This 
 #    object is tipically stored in OCI Object Storage by the module that manages topics.
-#--------------------------------------------------------------------------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
 #---------------------------------------
 # Tenancy Connectivity Variables
 #---------------------------------------
 
 tenancy_ocid         = "<tenancy OCID>"             # Get this from OCI Console (after logging in, go to top-right-most menu item and click option "Tenancy: <your tenancy name>").
 user_ocid            = "<user OCID>"                # Get this from OCI Console (after logging in, go to top-right-most menu item and click option "My profile").
-fingerprint          = "<PEM key fingerprint>"      # The fingerprint can be gathered from your user account. In the "My profile page, click "API keys" on the menu in left hand side).
+fingerprint          = "<PEM key fingerprint>"      # The fingerprint can be gathered from your user account. In the "My profile page, click "API keys" on the menu in left hand side.
 private_key_path     = "<path to the private key>"  # This is the full path on your local system to the API signing private key.
 private_key_password = ""                           # This is the password that protects the private key, if any.
 region               = "<your tenancy region>"      # This is your region, where all other events are created. It can be the same as home_region.

alarms/examples/external-dependency/variables.tf

@@ -28,6 +28,7 @@ variable "alarms_configuration" {
         pending_duration         = optional(string) # the period of time the condition must persist before the alarm is fired. Default is 5 minutes: "PT5M"
         metric_compartment_id    = optional(string)   # the compartment containing the metric being evaluated by the alarm. compartment_id is used if undefined. This attribute is overloaded: it can be either a compartment OCID or a reference (a key) to the compartment OCID.
         message_format           = optional(string) # format to use for notification messages sent from this alarm. Valid formats are: "RAW", "PRETTY_JSON", "ONS_OPTIMIZED". Default is "PRETTY_JSON".
+        repeat_notification_critical_alarms = optional(string) #option to repeat critical alarms
       }))
       destination_topic_ids = optional(list(string)) # List of topics to send alarms to. This attribute is overloaded: values can be either topic OCIDs or references (keys) to the topics OCIDs. The references are first looked up in the topics attribute and then in the topics_dependency object. 
       destination_stream_ids = optional(list(string)) # List of streams to send alarms to. This attribute is overloaded: values can be either stream OCIDs or references (keys) to the streams OCIDs. The references are first looked up in the streams attribute and then in the streams_dependency object. 

alarms/examples/supplied_alarms/README.md

@@ -12,7 +12,8 @@ The picture below shows side by side how the various attributes in *alarms_confi
 1. Rename *input.auto.tfvars.template* to *\<project-name\>.auto.tfvars*, where *\<project-name\>* is any name of your choice.
 
 2. Within *\<project-name\>.auto.tfvars*, provide tenancy connectivity information and adjust the *alarms_configuration* input variable, by making the appropriate substitutions:
-   - Replace *\<REPLACE-BY-COMPARTMENT-OCID\>*, *\<REPLACE-BY-METRIC-COMPARTMENT-OCID\>*, *\<REPLACE-BY-TOPIC-OCID\>* placeholders by appropriate compartment and topic OCIDs. 
+   - Replace *\<REPLACE-BY-COMPARTMENT-OCID\>*, *\<REPLACE-BY-METRIC-COMPARTMENT-OCID\>* placeholders by appropriate compartment OCIDs. Or utilize the reserved key "TENANCY-ROOT" for the root compartment OCID.
+   - Replace *\<REPLACE-BY-TOPIC-OCID\>* placeholders by appropriate topic OCIDs. 
 
 Refer to [Alarms' module README.md](../../README.md) for overall attributes usage.
 

alarms/examples/supplied_alarms/input.auto.tfvars.template

@@ -1,12 +1,12 @@
 # Copyright (c) 2023 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
-#--------------------------------------------------------------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 # 1. Rename this file to <project-name>.auto.tfvars, where <project-name> is a name of your choice.
 # 2. Provide values for "Tenancy Connectivity Variables".
-# 3. Replace <REPLACE-BY-COMPARTMENT-OCID>, <REPLACE-BY-METRIC-COMPARTMENT-OCID>, <REPLACE-BY-TOPIC-OCID> placeholders 
-#    by appropriate compartment and topic OCIDs.
-#--------------------------------------------------------------------------------------------------------------------------------------
+# 3. Replace <REPLACE-BY-COMPARTMENT-OCID>, <REPLACE-BY-METRIC-COMPARTMENT-OCID> by appropriate compartment OCIDs. Or utilize the reserved key "TENANCY-ROOT" for the root compartment OCID.
+# 4. Replace <REPLACE-BY-TOPIC-OCID> by appropriate topic OCIDs.
+#-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
 #---------------------------------------
 # Tenancy Connectivity Variables
@@ -24,7 +24,7 @@ region               = "<your tenancy region>"      # This is your region, where
 #---------------------------------------
 
 alarms_configuration = {
-  default_compartment_ocid = "<REPLACE-BY-COMPARTMENT-OCID>"
+  default_compartment_ocid = "<REPLACE-BY-COMPARTMENT-OCID>" # You can utilize the reserved key "TENANCY-ROOT" for the root compartment OCID.
   #default_defined_tags   = null
   #default_freeform_tags  = null
 
@@ -37,7 +37,7 @@ alarms_configuration = {
         query = "CpuUtilization[1m].mean() > 80"
         namespace = "oci_computeagent"
         pending_duration = "PT6M" # 6 minutes
-        metric_compartment_ocid = "<REPLACE-BY-METRIC-COMPARTMENT-OCID>"
+        metric_compartment_ocid = "<REPLACE-BY-METRIC-COMPARTMENT-OCID>" # You can utilize the reserved key "TENANCY-ROOT" for the root compartment OCID.
         severity = "CRITICAL"
         message_format = "ONS_OPTIMIZED"
         repeat_frequency_for_critical_alarms = "PT4H" # 4 hours

alarms/examples/supplied_alarms/main.tf

@@ -4,4 +4,5 @@
 module "supplied_alarms" {
   source               = "../../"
   alarms_configuration = var.alarms_configuration
+  tenancy_ocid = var.tenancy_ocid
 }

alarms/examples/vision/README.md

@@ -8,7 +8,7 @@ This example shows how to deploy alarms in OCI for a hypothetical Vision entity
 1. Rename *input.auto.tfvars.template* to *\<project-name\>.auto.tfvars*, where *\<project-name\>* is any name of your choice.
 
 2. Within *\<project-name\>.auto.tfvars*, provide tenancy connectivity information and adjust the *alarms_configuration* input variable, by making the appropriate substitutions:
-   - Replace *\<REPLACE-BY-COMPARTMENT-OCID\>* placeholders by appropriate compartment OCIDs. 
+   - Replace *\<REPLACE-BY-COMPARTMENT-OCID\>* placeholders by appropriate compartment OCIDs. Or utilize the reserved key "TENANCY-ROOT" for the root compartment OCID.
    - Replace *[email protected]* by actual email addresses.
 
 Refer to [Alarms' module README.md](../../README.md) for overall attributes usage.

alarms/examples/vision/input.auto.tfvars.template

@@ -1,20 +1,20 @@
 # Copyright (c) 2023 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
-#--------------------------------------------------------------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------------------------------------------------------------------------------------------
 # 1. Rename this file to <project-name>.auto.tfvars, where <project-name> is a name of your choice.
 # 2. Provide values for "Tenancy Connectivity Variables".
-# 3. Replace <REPLACE-BY-COMPARTMENT-OCID> placeholders by appropriate compartment OCIDs. 
+# 3. Replace <REPLACE-BY-COMPARTMENT-OCID> placeholders by appropriate compartment OCIDs. Or utilize the reserved key "TENANCY-ROOT" for the root compartment OCID.
 # 4. Replace [email protected] by actual email addresses.
-#--------------------------------------------------------------------------------------------------------------------------------------
+#-------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
 #---------------------------------------
 # Tenancy Connectivity Variables
 #---------------------------------------
 
 tenancy_ocid         = "<tenancy OCID>"             # Get this from OCI Console (after logging in, go to top-right-most menu item and click option "Tenancy: <your tenancy name>").
 user_ocid            = "<user OCID>"                # Get this from OCI Console (after logging in, go to top-right-most menu item and click option "My profile").
-fingerprint          = "<PEM key fingerprint>"      # The fingerprint can be gathered from your user account. In the "My profile page, click "API keys" on the menu in left hand side).
+fingerprint          = "<PEM key fingerprint>"      # The fingerprint can be gathered from your user account. In the "My profile page, click "API keys" on the menu in left hand side.
 private_key_path     = "<path to the private key>"  # This is the full path on your local system to the API signing private key.
 private_key_password = ""                           # This is the password that protects the private key, if any.
 region               = "<your tenancy region>"      # This is your region, where all other events are created. It can be the same as home_region.
@@ -24,7 +24,7 @@ region               = "<your tenancy region>"      # This is your region, where
 #---------------------------------------
 
 alarms_configuration = {
-  default_compartment_id = "<REPLACE-BY-COMPARTMENT-OCID>"
+  default_compartment_id = "<REPLACE-BY-COMPARTMENT-OCID>" # You can utilize the reserved key "TENANCY-ROOT" for the root compartment OCID.
   #default_defined_tags   = null
   #default_freeform_tags  = null
 

alarms/examples/vision/main.tf

@@ -4,4 +4,5 @@
 module "vision_alarms" {
   source               = "../../"
   alarms_configuration = var.alarms_configuration
+  tenancy_ocid         = var.tenancy_ocid
 }