Document how to configure external data stores. #851
Conversation
yzl
changed the title
| @@ -119,3 +126,126 @@ sudo chef-automate config patch config.toml | |||
| ``` | |||
|
|
|||
| and retry opening Chef Automate in your browser. | |||
|
|
|||
| ### Configuring External Data Stores | |||
There was a problem hiding this comment.
I thought it was worth spelling this out here (instead of pointing to the configuration page) because if someone knows upfront they need an external data store, we want them to do their initial deploy that way. I'm not sure this is the best way to encourage that, so I'm willing to hear other ideas.
There was a problem hiding this comment.
I'm wondering if we want the the initial install instructions to be the only instructions for now?
There was a problem hiding this comment.
@stevendanna That makes sense to me, so I removed the ones on the configuration page.
| Data Stores]({{< relref "#configuring-external-data-stores" >}}) for information on | ||
| configuring Chef Automate to use an externally-deployed PostgreSQL database cluster | ||
| and/or Elasticsearch cluster. If you have requirements around a highly-available | ||
| deployment of Chef Automate, please reach out to a Customer Success or Professional |
There was a problem hiding this comment.
Are these the right folks to contact?
yzl
changed the title
| @@ -698,6 +710,37 @@ Then run `chef-automate config patch </path/to/your-file.toml>` to deploy your c | |||
| # name = "automate" | |||
| ``` | |||
|
|
|||
| #### Configuring An External PostgreSQL Database | |||
| To use Chef Automate with an external PostgreSQL cluster, create a `.toml` file containing the following partial configuration. | |||
There was a problem hiding this comment.
🤔I'm wondering if we prefer "TOML file" to ".toml file"?
There was a problem hiding this comment.
We're not consistent, so I'm going to make us consistent by making it "TOML file".
| enable = true | ||
|
|
||
| ``` | ||
|
|
There was a problem hiding this comment.
I think we are OK not restarting the world in these directions because the restart-workaround code will restart all pgsql clients. However, I think in general we might still want to do a full service restart so that database initialization code in the various services run again.
| @@ -119,3 +126,126 @@ sudo chef-automate config patch config.toml | |||
| ``` | |||
|
|
|||
| and retry opening Chef Automate in your browser. | |||
|
|
|||
| ### Configuring External Data Stores | |||
There was a problem hiding this comment.
I'm wondering if we want the the initial install instructions to be the only instructions for now?
Signed-off-by: Yvonne Lam <yvonne@chef.io>
install only. Signed-off-by: Yvonne Lam <yvonne@chef.io>
Signed-off-by: Yvonne Lam <yvonne@chef.io>
🔩 Description
Document the current tested state of configuring external data stores with Automate.
Fixes #846
👍 Definition of Done
👟 Demo Script / Repro Steps
⛓️ Related Resources
✅ Checklist