-
Notifications
You must be signed in to change notification settings - Fork 56
MongoDB doku update #736
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
MongoDB doku update #736
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
257e346
Update mongodbflex_instance.md
lucaaayk 2e059f2
Update mongodbflex_user.md
lucaaayk 9d6cda7
Merge branch 'stackitcloud:main' into main
lucaaayk 86c2263
Updated MongoDB Documentation
lucaaayk e43025b
Updated MongoDB Documentation
lucaaayk 32832b4
Merge remote-tracking branch 'origin/MongoDB-Doku-Update' into MongoD…
lucaaayk File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 2 additions & 0 deletions
2
stackit/internal/services/mongodbflex/instance/information-instance.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| !> STACKIT provides a Terraform provider that enables the deployment and ordering of MongoDB Flex. However, please exercise caution when using Terraform, as some API calls initiated through Terraform may behave differently than expected. Before applying any changes, ensure you review them carefully or contact us if you are unsure about the usage. **Please note that updates may result in the recreation of the entire instance, which could lead to data loss.** | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,6 +2,7 @@ | |
|
|
||
| import ( | ||
| "context" | ||
| _ "embed" | ||
| "fmt" | ||
| "net/http" | ||
| "regexp" | ||
|
|
@@ -58,6 +59,9 @@ | |
| Options types.Object `tfsdk:"options"` | ||
| } | ||
|
|
||
| //go:embed information-instance.md | ||
| var markdownDescription string | ||
|
|
||
| // Struct corresponding to Model.Flavor | ||
| type flavorModel struct { | ||
| Id types.String `tfsdk:"id"` | ||
|
|
@@ -144,7 +148,7 @@ | |
| } else { | ||
| apiClient, err = mongodbflex.NewAPIClient( | ||
| config.WithCustomAuth(providerData.RoundTripper), | ||
| config.WithRegion(providerData.GetRegion()), | ||
| config.WithRegion(providerData.Region), | ||
| ) | ||
| } | ||
|
|
||
|
|
@@ -179,7 +183,8 @@ | |
| } | ||
|
|
||
| resp.Schema = schema.Schema{ | ||
| Description: descriptions["main"], | ||
| MarkdownDescription: descriptions["main"] + "\n\n" + markdownDescription, | ||
| Description: descriptions["main"], | ||
| Attributes: map[string]schema.Attribute{ | ||
| "id": schema.StringAttribute{ | ||
| Description: descriptions["id"], | ||
|
|
@@ -250,9 +255,6 @@ | |
| }, | ||
| "replicas": schema.Int64Attribute{ | ||
| Required: true, | ||
| PlanModifiers: []planmodifier.Int64{ | ||
| int64planmodifier.RequiresReplace(), | ||
| }, | ||
|
Comment on lines
-253
to
-255
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. And this one |
||
| }, | ||
| "storage": schema.SingleNestedAttribute{ | ||
| Required: true, | ||
|
|
||
2 changes: 2 additions & 0 deletions
2
stackit/internal/services/mongodbflex/user/information-user.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| !> STACKIT provides a Terraform provider that enables the deployment and ordering of MongoDB Flex. However, please exercise caution when using Terraform, as some API calls initiated through Terraform may behave differently than expected. Before applying any changes, ensure you review them carefully or contact us if you are unsure about the usage. **Please note that updates may result in the recreation of the entire instance, which could lead to data loss.** | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,6 +2,7 @@ | |
|
|
||
| import ( | ||
| "context" | ||
| _ "embed" | ||
| "fmt" | ||
| "net/http" | ||
| "strings" | ||
|
|
@@ -45,6 +46,9 @@ | |
| Uri types.String `tfsdk:"uri"` | ||
| } | ||
|
|
||
| //go:embed information-user.md | ||
| var markdownDescription string | ||
|
|
||
| // NewUserResource is a helper function to simplify the provider implementation. | ||
| func NewUserResource() resource.Resource { | ||
| return &userResource{} | ||
|
|
@@ -83,7 +87,7 @@ | |
| } else { | ||
| apiClient, err = mongodbflex.NewAPIClient( | ||
| config.WithCustomAuth(providerData.RoundTripper), | ||
| config.WithRegion(providerData.GetRegion()), | ||
| config.WithRegion(providerData.Region), | ||
|
Comment on lines
-86
to
+90
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. And this one |
||
| ) | ||
| } | ||
|
|
||
|
|
@@ -108,7 +112,8 @@ | |
| } | ||
|
|
||
| resp.Schema = schema.Schema{ | ||
| Description: descriptions["main"], | ||
| MarkdownDescription: descriptions["main"] + "\n\n" + markdownDescription, | ||
| Description: descriptions["main"], | ||
| Attributes: map[string]schema.Attribute{ | ||
| "id": schema.StringAttribute{ | ||
| Description: descriptions["id"], | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you revert this changes