Add namespace support to elasticstack_kibana_synthetics_monitor resource

[Copilot]

This PR adds support for the namespace attribute to the elasticstack_kibana_synthetics_monitor resource, allowing users to set the data stream namespace independently from the space_id.

Problem

Previously, the data stream namespace was automatically derived from the space_id field, making it impossible to set a custom namespace directly. However, the Kibana UI allows setting the namespace independently (as shown in the "Data stream namespace" field in the screenshot), but this functionality was missing from the Terraform provider.

Solution

• Added namespace attribute to the Terraform schema with proper documentation
• Implemented fallback logic: If namespace is not explicitly set, it defaults to the space_id value (maintaining backward compatibility)
• Updated CRUD operations to handle the namespace field independently from space_id
• Added comprehensive tests including a new acceptance test TestSyntheticMonitorHTTPResourceWithNamespace

Usage Example

resource "elasticstack_kibana_synthetics_monitor" "example" {
  name      = "my-monitor"
  space_id  = "my-space"
  namespace = "custom-namespace"  # New field!
  
  http = {
    url = "https://example.com"
  }
  
  private_locations = [elasticstack_kibana_synthetics_private_location.example.label]
}

Backward Compatibility

This change is fully backward compatible. Existing configurations will continue to work as before - if namespace is not specified, it will automatically use the space_id value.

Testing

• All existing unit tests updated and passing
• New acceptance test added to verify namespace functionality
• Comprehensive test coverage for the new attribute

Fixes #1164.
Fixes #1131.
Fixes #1083.

---

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

[cla-checker-service]

❌ Author of the following commits did not sign a Contributor Agreement:
fcd90c4, 430e4d3, 0b86113, e5820b3, 11d2ab5, ab53e8f, f9589ad, 4e63119, d75c5fb, 81e9976

Please, read and sign the above mentioned agreement if you want to contribute to this project

[tobio]

These changes mean that we don't correctly read the default for space_id. Can you:

• Add a default plan modifier to the space_id attribute. There's already a plan modifier in the project that will work for this in internal/utils/planmodifiers/string_default.go
• Change the space_id RequiresReplace plan modifier to RequiresReplaceIf. Only force a replacement if:
  • The value is configured
  • The value has changed
  • The change is something other than "default" to "", or "" to "default"

[Copilot]

These changes mean that we don't correctly read the default for space_id. Can you:

• Add a default plan modifier to the space_id attribute. There's already a plan modifier in the project that wil...

Added the default plan modifier using StringUseDefaultIfUnknown("default") and implemented a custom RequiresReplaceIf function that only forces replacement when the value is configured, has changed, and the change is not between empty/"" and "default". Changes in commit f9589ad.

[Copilot]

make lint is failing as the generated docs need to be updated. Run make docs-generate and commit the resulting change.

Fixed the documentation generation issue. Installed Terraform locally and ran make docs-generate successfully. The generated documentation now includes the new namespace attribute with proper description and validation rules. Changes in commit 4e63119.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

• checkpoint-api.hashicorp.com
  • Triggering command: /usr/local/bin/terraform init -no-color -input=false -backend=true -get=false -upgrade=false -plugin-dir=./plugins (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to my firewall allow list

[tobio]

LGTM

[tobio]

Suggested change

	MarkdownDescription: "The namespace field should be lowercase and not contain spaces. The namespace must not include any of the following characters: *, \\, /, ?, \", <, >, |, whitespace, ,, #, :, or -. Default: `default`",
	MarkdownDescription: "An identifier for the space. If space_id is not provided, the default space is used. This value is used for the default for `namespace` when that attribute is not provided.",

[Copilot]

Updated the space_id MarkdownDescription to correctly describe its purpose and relationship with the namespace attribute in commit d75c5fb.

[tobio]

@copilot CI is failing since the documentation hasn't been updated. Run make docs-generate and commit the result.

[Copilot]

@copilot CI is failing since the documentation hasn't been updated. Run make docs-generate and commit the result.

Documentation has been updated by running make docs-generate and committing the result. The generated documentation now includes the proper description for the namespace attribute and its relationship with space_id. Changes in commit 6c6a14b.

[tobio]

CI is failing as the docs haven't been regenerated. Run make docs-generate and commit the result.

[Copilot]

CI is failing as the docs haven't been regenerated. Run make docs-generate and commit the result.

The documentation is already up to date. I ran make docs-generate and it completed successfully without generating any changes, indicating the docs are in sync with the current schema. The full lint process (make lint) also passes with 0 issues.

[biscout42]

I'm sorry, I missed that PR and created a duplicate here #1247

Couple of notes.

FYI: make test for this PR fails for me in

/libs/go-kibana-rest

and I assume it will fail if we pull changed from main due-to https://github.com/elastic/terraform-provider-elasticstack/blob/main/libs/go-kibana-rest/docker-compose.yml#L3

The function requiresReplaceIfSpaceIdChanged looks unnecessary, or I don't understand what does it bring in comparison to built in stringplanmodifier.RequiresReplace().

The value in the description namespace = "custom-namespace" is incorrect, because fleet namespace doesn't allow hyphen.

The branch I created has this comments applied and adds more tests / improve maintainability (small renaming) at libs/go-kibana-rest.

Last but not least, IIUC kibana sets default value for namespace and I assume we need to use this, and not set default to space as in this PR . IMHO stringplanmodifier.UseStateForUnknown() is enough for namespace and we don't need to fall back to space_id if namespace is not set. Reason: if kibana changed defaults we will need to update provider.

I would like to have it merged to fix the issue for our clients.

@tobio , please, advice, would you like to move changes above in this branch or merge the duplicate PR?

[tobio]

IMHO stringplanmodifier.UseStateForUnknown() is enough for namespace and we don't need to fall back to space_id if namespace is not set.

What happens when someone upgrades their provider version in this case though? At the moment, we'll have set namespace to space_id, which won't have been persisted in state.

As an entirely new resource I'd agree with you, but that sounds like a breaking change that we can somewhat simply avoid, maintaining the current behaviour unless explicitly told otherwise.

[biscout42]

What happens when someone upgrades their provider version in this case though?

let me check that with synthetic folks. My current understanding we use space_id as a default and kibana used the same.

I'll also check, if we need to re-create a monitor if a namespace changes.

[tobio]

If space-id is non-default we have a problem regardless though right? The namespace would be changed without the user necessarily expecting it to have.