Prometheus for database #787

lpatte · 2024-12-17T10:57:12Z

Description

Add resource to manage Prometheus for Databases Services

Type of change

Please delete options that are not relevant.

New feature (non-breaking change which adds functionality)
Documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Test A: make testacc TESTARGS="-run TestAccCloudProjectDatabaseMongodbPrometheusDataSource_basic"
Test B: make testacc TESTARGS="-run TestAccCloudProjectDatabasePrometheusDataSource_basic"
Test C: make testacc TESTARGS="-run TestAccCloudProjectDatabasePrometheus_importBasic"
Test D: make testacc TESTARGS="-run TestAccCloudProjectDatabaseMongodbPrometheus_basic"
Test E: make testacc TESTARGS="-run TestAccCloudProjectDatabasePrometheus_basic"

Test Configuration:

Existing HCL configuration you used:

resource "ovh_cloud_project_database_prometheus" "prom2" {
    service_name = "e55487da3ae846d7bd17bae8011fd4f8"
    engine       = "postgresql"
    cluster_id   = "xxxxxxxxxxxx"
    password_reset = "poto5"
} 

output "password2" {
    value = ovh_cloud_project_database_prometheus.prom2.password
    sensitive  = true
}

data "ovh_cloud_project_database_prometheus" "prom2" {
    service_name = "xxxxxxxxxxxx"
    engine       = "postgresql"
    cluster_id   = ovh_cloud_project_database_prometheus.prom2.cluster_id
}

resource "ovh_cloud_project_database_mongodb_prometheus" "prom" {
    service_name = "xxxxxxxxxxxx"
    cluster_id   = "xxxxxxxxxxxx"
    password_reset = "poto3"
}

output "password" {
    value = ovh_cloud_project_database_mongodb_prometheus.prom.password
    sensitive  = true
}

data "ovh_cloud_project_database_mongodb_prometheus" "prom" {
    service_name = "xxxxxxxxxxxx"
    cluster_id   = ovh_cloud_project_database_mongodb_prometheus.prom.cluster_id
}

lpatte · 2024-12-18T16:31:12Z

Waiting some backend devs on this feature to test with last version of the feature before merge this PR

lpatte · 2025-01-07T14:14:46Z

Backend development finished and resources tested with

amstuta · 2025-01-10T09:03:44Z

ovh/types_cloud_project_database.go

@@ -85,6 +85,7 @@ type CloudProjectDatabaseResponse struct {
 	Version               string                                      `json:"version"`
 	Disk                  CloudProjectDatabaseDisk                    `json:"disk"`
 	AdvancedConfiguration map[string]string                           `json:"advancedConfiguration"`
+	EnablePrometheus      bool                                        `json:"EnablePrometheus"`


Suggested change

EnablePrometheus bool `json:"EnablePrometheus"`

EnablePrometheus bool `json:"enablePrometheus"`

amstuta · 2025-01-10T09:05:45Z

ovh/types_cloud_project_database.go

+	)
+
+	res := &CloudProjectDatabasePrometheusAccessResponse{}
+	//log.Printf("[DEBUG] Will create pro: %+v for cluster %s from project %s", params, clusterId, serviceName)


Suggested change

//log.Printf("[DEBUG] Will create pro: %+v for cluster %s from project %s", params, clusterId, serviceName)

amstuta · 2025-01-10T09:20:44Z

ovh/resource_cloud_project_database_mongodb_prometheus.go

+				Required:    true,
+			},
+			"password_reset": {
+				Type:        schema.TypeString,


I would really prefer a bool property here as it will be way clearer for the end user. I understand that it requires him to input true on a first apply and then set the field to false to avoid re-resetting his password, but I think it's better this way

No, it's not how terraform is use, we cannot ask our user to change the resource between the first and second apply. The user must be able to aply 5 time his code without update if he do not change the code.
We use the same strategy for user resources, and for all theses resources the documentation explain how to use it.
Our customers already use it without issue.

What about password_reset_last_request_date with datetime format ?
That would be clearer IMO

Agree with @amstuta that string is clearly not the way to go.

Force datetime format is possible but in fact it's just a string with validate function (https://developer.hashicorp.com/terraform/plugin/sdkv2/schemas/schema-types#date-time-data).
It's just a trigger attribute with this documentation :

password_reset - (Optional) Arbitrary string to change to trigger a password update. Use the terraform refresh command after executing terraform apply to update the output with the new password.

From my point of view, add a validate function will just add complexity for the user.
Also, if I change it here I have to change it in user resources and that will be a kind of breaking change.

amstuta · 2025-01-10T09:21:19Z

ovh/types_cloud_project_database.go

+	}
+	d.SetId("")
+	return nil
+


Suggested change

amstuta · 2025-01-10T13:44:21Z

website/docs/d/cloud_project_database_prometheus.html.markdown

+
+# ovh_cloud_project_database_prometheus (Data Source)
+
+Use this data source to get information about a prometheus of a database cluster associated with a public cloud project.


optional, but maybe you could add something like for mongodb, please use the other datasource ...

rbeuque74

Change type datetime

amstuta · 2025-01-22T15:47:55Z

website/docs/r/cloud_project_database_m3db_user.html.markdown

+This attribute can be an arbitratry string but we recomand 2 formats:
+- a datetime to keep a trace of the last reset
+- a md5 of another variables to automaticaly triger it based on this variable update


Suggested change

This attribute can be an arbitratry string but we recomand 2 formats:

- a datetime to keep a trace of the last reset

- a md5 of another variables to automaticaly triger it based on this variable update

This attribute can be an arbitrary string but we recommend 2 formats:

- a datetime to keep a trace of the last reset

- a md5 of other variables to automatically trigger it based on this variable update

amstuta · 2025-01-22T15:49:19Z

website/docs/r/cloud_project_database_mongodb_prometheus.html.markdown

+This attribute can be an arbitratry string but we recomand 2 formats:
+- a datetime to keep a trace of the last reset
+- a md5 of another variables to automaticaly triger it based on this variable update


Suggested change

This attribute can be an arbitratry string but we recomand 2 formats:

- a datetime to keep a trace of the last reset

- a md5 of another variables to automaticaly triger it based on this variable update

This attribute can be an arbitrary string but we recommend 2 formats:

- a datetime to keep a trace of the last reset

- a md5 of other variables to automatically trigger it based on this variable update

amstuta · 2025-01-22T15:49:41Z

website/docs/r/cloud_project_database_mongodb_user.html.markdown

+This attribute can be an arbitratry string but we recomand 2 formats:
+- a datetime to keep a trace of the last reset
+- a md5 of another variables to automaticaly triger it based on this variable update


Suggested change

This attribute can be an arbitratry string but we recomand 2 formats:

- a datetime to keep a trace of the last reset

- a md5 of another variables to automaticaly triger it based on this variable update

This attribute can be an arbitrary string but we recommend 2 formats:

- a datetime to keep a trace of the last reset

- a md5 of other variables to automatically trigger it based on this variable update

amstuta · 2025-01-22T15:49:58Z

website/docs/r/cloud_project_database_opensearch_user.html.markdown

+This attribute can be an arbitratry string but we recomand 2 formats:
+- a datetime to keep a trace of the last reset
+- a md5 of another variables to automaticaly triger it based on this variable update


Suggested change

This attribute can be an arbitratry string but we recomand 2 formats:

- a datetime to keep a trace of the last reset

- a md5 of another variables to automaticaly triger it based on this variable update

This attribute can be an arbitrary string but we recommend 2 formats:

- a datetime to keep a trace of the last reset

- a md5 of other variables to automatically trigger it based on this variable update

amstuta · 2025-01-22T15:50:18Z

website/docs/r/cloud_project_database_postgresql_user.html.markdown

+This attribute can be an arbitratry string but we recomand 2 formats:
+- a datetime to keep a trace of the last reset
+- a md5 of another variables to automaticaly triger it based on this variable update


Suggested change

This attribute can be an arbitratry string but we recomand 2 formats:

- a datetime to keep a trace of the last reset

- a md5 of another variables to automaticaly triger it based on this variable update

This attribute can be an arbitrary string but we recommend 2 formats:

- a datetime to keep a trace of the last reset

- a md5 of other variables to automatically trigger it based on this variable update

amstuta · 2025-01-22T15:50:33Z

website/docs/r/cloud_project_database_prometheus.html.markdown

+This attribute can be an arbitratry string but we recomand 2 formats:
+- a datetime to keep a trace of the last reset
+- a md5 of another variables to automaticaly triger it based on this variable update


Suggested change

This attribute can be an arbitratry string but we recomand 2 formats:

- a datetime to keep a trace of the last reset

- a md5 of another variables to automaticaly triger it based on this variable update

This attribute can be an arbitrary string but we recommend 2 formats:

- a datetime to keep a trace of the last reset

- a md5 of other variables to automatically trigger it based on this variable update

amstuta · 2025-01-22T15:50:52Z

website/docs/r/cloud_project_database_redis_user.html.markdown

+This attribute can be an arbitratry string but we recomand 2 formats:
+- a datetime to keep a trace of the last reset
+- a md5 of another variables to automaticaly triger it based on this variable update


Suggested change

This attribute can be an arbitratry string but we recomand 2 formats:

- a datetime to keep a trace of the last reset

- a md5 of another variables to automaticaly triger it based on this variable update

This attribute can be an arbitrary string but we recommend 2 formats:

- a datetime to keep a trace of the last reset

- a md5 of other variables to automatically trigger it based on this variable update

amstuta · 2025-01-22T15:52:40Z

website/docs/r/cloud_project_database_user.html.markdown

+This attribute can be an arbitratry string but we recomand 2 formats:
+- a datetime to keep a trace of the last reset
+- a md5 of another variables to automaticaly triger it based on this variable update


Suggested change

This attribute can be an arbitratry string but we recomand 2 formats:

- a datetime to keep a trace of the last reset

- a md5 of another variables to automaticaly triger it based on this variable update

This attribute can be an arbitrary string but we recommend 2 formats:

- a datetime to keep a trace of the last reset

- a md5 of other variables to automatically trigger it based on this variable update

discussed directly

Prometheus for database

605211a

lpatte requested review from rbeuque74, deathiop, amstuta, mxpetit, yomovh and marie-j as code owners December 17, 2024 10:57

lpatte marked this pull request as draft December 17, 2024 12:00

lpatte marked this pull request as ready for review January 7, 2025 14:13

amstuta reviewed Jan 10, 2025

View reviewed changes

follow review

cb3f7b8

rbeuque74 previously requested changes Jan 13, 2025

View reviewed changes

add documentation for password_reset

70799d0

lpatte requested a review from a team as a code owner January 21, 2025 15:19

amstuta reviewed Jan 22, 2025

View reviewed changes

fix typo in doc

c57fdcb

amstuta approved these changes Jan 24, 2025

View reviewed changes

amstuta merged commit c02620f into master Jan 24, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prometheus for database #787

Prometheus for database #787

lpatte commented Dec 17, 2024

lpatte commented Dec 18, 2024

lpatte commented Jan 7, 2025

amstuta Jan 10, 2025

amstuta Jan 10, 2025

amstuta Jan 10, 2025

lpatte Jan 13, 2025

rbeuque74 Jan 13, 2025

rbeuque74 Jan 13, 2025

lpatte Jan 13, 2025 •

edited

Loading

amstuta Jan 10, 2025

amstuta Jan 10, 2025

rbeuque74 left a comment

amstuta Jan 22, 2025

amstuta Jan 22, 2025

amstuta Jan 22, 2025

amstuta Jan 22, 2025

amstuta Jan 22, 2025

amstuta Jan 22, 2025

amstuta Jan 22, 2025

amstuta Jan 22, 2025

	EnablePrometheus bool `json:"EnablePrometheus"`
	EnablePrometheus bool `json:"enablePrometheus"`


		# ovh_cloud_project_database_prometheus (Data Source)

		Use this data source to get information about a prometheus of a database cluster associated with a public cloud project.

Prometheus for database #787

Prometheus for database #787

Conversation

lpatte commented Dec 17, 2024

Description

Type of change

How Has This Been Tested?

lpatte commented Dec 18, 2024

lpatte commented Jan 7, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lpatte Jan 13, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rbeuque74 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lpatte Jan 13, 2025 •

edited

Loading