Docs: Database Instance Operations #223
Conversation
Documentation on how to start, stop, and restart database instances using the control plane PLAT-325
mmols
left a comment
mmols
left a comment
There was a problem hiding this comment.
Thanks for this - I've left a few comments to adjust to align with other nearby docs. Once we address that, we can send to Susan for final review.
| @@ -0,0 +1,93 @@ | |||
| # Database Instances | |||
There was a problem hiding this comment.
I suggest renaming this to "Managing Database Instances". You will also need to place it in the mkdocs.yml file so that it's rendered in the menu under "Using Control Plane". I suggest placing it below Read Replicas.
| @@ -0,0 +1,93 @@ | |||
| # Database Instances | |||
|
|
|||
| A database instance is: | |||
There was a problem hiding this comment.
I would revise this top section to keep it short - its likely we need additional articles on managing users and port selection. I would write a few paragraphs that re-iterate what Instances are, and why you might need to manage them. You can pull from the Concepts page for some wording.
| * Must remain consistent across all instances | ||
| * Cannot conflict with system users | ||
|
|
||
| States |
There was a problem hiding this comment.
I would pull this information into a subheading "Monitoring Instances" and show the user how you can fetch this information using the GetDatabase endpoint. The user will need to find the instance IDs to use the rest of the operations below.
You can also speak to the postgres status information under each instance, notably the pending_restart field which highlights if a configuration change is pending that requires a restart.
|
|
||
|
|
||
|
|
||
| # Database Instance Operations |
There was a problem hiding this comment.
There should be only 1 top level header per page, so I would remove this and just have:
- Monitoring Instances
- Stopping Instances
- Starting Instances
- Restarting Instances
|
|
||
|
|
||
| ```sh | ||
| curl http://host-3:3000/v1/databases/example/instances/n1/stop |
There was a problem hiding this comment.
Each of these sample requests is a POST. This might work with a GET, but we should follow the spec accordingly.
| * Other instances remain unaffected | ||
| * A stopped instance continues to appear under list-databases with state: "stopped" | ||
|
|
||
| Example: Stop a database “example” whose instance ID is “n1” |
There was a problem hiding this comment.
The Instance IDs are always generated - they look something like this: example-n1-689qacsi, which is <database-id>-<node-name>-<host-id-hash> - let's follow this here and have carry through from our other docs pages that use example.
Summary
Adds a new docs page that documents how to start, stop, and restart database instances using the control plane
PLAT-325