oci_database_db_system documentation requires major corrections/updates

[luckeyca]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Terraform Version and Provider Version

Terraform v1.9.3
on linux_amd64

• provider registry.terraform.io/oracle/oci v6.31.0

Affected Resource(s)

oci_database_db_system

Terraform Configuration Files

N/A

Debug Output

Panic Output

Expected Behavior

oci_database_db_system resource documentation should be up-to-date and accurate

Actual Behavior

There are full of errors, lack of clarity and omissions in the current documentation which requires major review and updates. Please see some, but definitely not all, of the examples as below

Steps to Reproduce

1. is_health_monitoring_enabled argument. current document indicates it's an updatable setting in the resource. In fact it's not supported by both single or 2-node vm db system.
2. in db_home block, defined_tags and freeform_tags are listed as validate arguments. However, whenever they are set, terraform apply constantly tries to set them without success. these 2 arguments are indeed declared in source code. so it could be a combination of the code issue and documentation issue as they may be not supported by the backend api.
3. in database block, sid_prefix is listed as a valid argument. In fact, not only regardless where(main/db_home/database) to put this argument, the terraform apply says this argument is invalid, but also in the source code, this argument cannot be found as a declared variable.
4. db_unique_name argument is listed in the wrong location in both code example and in documentation. It should be in database block, not db_home block
5. in the backup_destination_details blocks, what are the valid "type" options? Even after comparing oci console, ansible documentation and source code, they are all inconsistent and thus need clarification.
6. also from point 5 above, if ASR is one of the type option, how to get the ocid dynamically/programmatically?
7. In the "attribute reference"(terraform output) section, there are many useful/important terraform outputs missing. However, upon looking into terraform state file, actually db_home ocid, cdb ocid, cdb connection strings and db_unique_name DO exist, but NOT documented. only pdb releated settings(ocid, passwords, pdb connection strings) are actually missing.

These are just some of the major issues identified. please look through the documentation and update it accordingly.

Important Factoids

References