Skip to content

Commit c2d7007

Browse files
committed
chore: describe limitation of meshPlatform
BD-1953 [BD-1953](https://meshcloud.bolddesk.com/agent/tickets/1953)
1 parent 9ce201b commit c2d7007

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

docs/resources/platform.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,18 @@ page_title: "meshstack_platform Resource - terraform-provider-meshstack"
44
subcategory: ""
55
description: |-
66
Represents a meshStack platform.
7+
Please note that the meshPlatform API endpoints are still in preview state and therefore the following limitations apply:
8+
Deleting and re-creating a platform with the same identifier is not possible. Once you have used a platform identifier, you cannot use it again, even if the platform has been deleted. You may run into this issue when you attempt to modify an immutable attribute and terraform therefore attempts to replace (i.e., delete and recreate) the entire platform, which will result in an error with a status code of 409 due to the identifier already being used by a deleted platform.Changing the owning workspace of a platform (metadata.owned_by_workspace) is not possible. To transfer the ownership of a platform, you must use meshPanel.
79
---
810

911
# meshstack_platform (Resource)
1012

1113
Represents a meshStack platform.
1214

15+
Please note that the meshPlatform API endpoints are still in preview state and therefore the following limitations apply:
16+
* Deleting and re-creating a platform with the same identifier is not possible. Once you have used a platform identifier, you cannot use it again, even if the platform has been deleted. You may run into this issue when you attempt to modify an immutable attribute and terraform therefore attempts to replace (i.e., delete and recreate) the entire platform, which will result in an error with a status code of `409` due to the identifier already being used by a deleted platform.
17+
* Changing the owning workspace of a platform (`metadata.owned_by_workspace`) is not possible. To transfer the ownership of a platform, you must use meshPanel.
18+
1319
## Example Usage
1420

1521
```terraform

internal/provider/platform_resource.go

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,13 @@ func (r *platformResource) Configure(_ context.Context, req resource.ConfigureRe
6565
}
6666

6767
func (r *platformResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
68+
markdownDescription := "Represents a meshStack platform.\n\n" +
69+
"Please note that the meshPlatform API endpoints are still in preview state and therefore the following limitations apply:\n" +
70+
"* Deleting and re-creating a platform with the same identifier is not possible. Once you have used a platform identifier, you cannot use it again, even if the platform has been deleted. You may run into this issue when you attempt to modify an immutable attribute and terraform therefore attempts to replace (i.e., delete and recreate) the entire platform, which will result in an error with a status code of `409` due to the identifier already being used by a deleted platform.\n" +
71+
"* Changing the owning workspace of a platform (`metadata.owned_by_workspace`) is not possible. To transfer the ownership of a platform, you must use meshPanel."
72+
6873
resp.Schema = schema.Schema{
69-
MarkdownDescription: "Represents a meshStack platform.",
74+
MarkdownDescription: markdownDescription,
7075
Attributes: map[string]schema.Attribute{
7176
"api_version": schema.StringAttribute{
7277
MarkdownDescription: "Platform datatype version",

0 commit comments

Comments
 (0)