add new terraform docs #34221
add new terraform docs #34221
Conversation
|
@jubrad thanks for reviving this! |
kay-kim
left a comment
kay-kim
left a comment
There was a problem hiding this comment.
Hey ... won't have time to add a patch to this today (double-checking the upgrade)... so, am leaving some comments for now in case people have a window free.
Depending on when, I'll continue reviewing or patching. Heads up ... I'm out starting Monday next week.
| {{</ tip >}} | ||
| | Guide | Description | | ||
| |-------|-------------| | ||
| | [Terraform Provider](/installation/install-on-aws/terraform-module/) | Install Materialize on AWS using our new Unified Terraform Provider | |
There was a problem hiding this comment.
In the Description for the new Unified .... Do we want to add Recommended annotation? like
| Recommended. Install Materialize ...
| | Guide | Description | | ||
| |-------|-------------| | ||
| | [Terraform Provider](/installation/install-on-aws/terraform-module/) | Install Materialize on AWS using our new Unified Terraform Provider | | ||
| | [Terraform Provider (legacy)](/installation/install-on-aws/legacy-terraform-module/) | Install Materialize on AWS using our Terraform Provider (legacy) | |
There was a problem hiding this comment.
The description "using our Terraform..." -> "using our legacy Terraform Provider"
doc/user/content/installation/install-on-aws/appendix-deployment-guidelines.md
Outdated
Show resolved
Hide resolved
doc/user/content/installation/install-on-aws/appendix-deployment-guidelines.md
Outdated
Show resolved
Hide resolved
doc/user/content/installation/install-on-aws/appendix-deployment-guidelines.md
Outdated
Show resolved
Hide resolved
doc/user/content/installation/install-on-aws/terraform-module/_index.md
Outdated
Show resolved
Hide resolved
doc/user/content/installation/install-on-aws/terraform-module/_index.md
Outdated
Show resolved
Hide resolved
doc/user/content/installation/install-on-aws/terraform-module/_index.md
Outdated
Show resolved
Hide resolved
|
|
||
| ```hcl | ||
| name_prefix = "simple-demo" | ||
| aws_region = "us-east-1" |
There was a problem hiding this comment.
should we mention as a comment that they can change the aws_region?
doc/user/content/installation/install-on-aws/terraform-module/_index.md
Outdated
Show resolved
Hide resolved
| @@ -0,0 +1,187 @@ | |||
| --- | |||
| title: "Upgrade Overview" | |||
There was a problem hiding this comment.
Oh ... this was incorporated into the landing page https://github.com/MaterializeInc/materialize/pull/34221/files#diff-eac74265be1711fcdccf99e1c740cdcc0054ab604c658782a67e6aa26daad915L15
So, I think this can go away?
There was a problem hiding this comment.
Oh yeah, I did just notice that, and I'm not sure I agree.
I knid of want the landing page portion to go away and think we should move back to an upgrade overview doc 😆
Probably best to chat through this through on zoom.
There was a problem hiding this comment.
It's only because of the current organization that it's included at the top. That is, for the upgrade landing page, we would want to reorg the other files.
Currently, as it stands, we have:
- Self-Managed Deployments
- Install on kind
- Upgrade
- Install on AWS
- TF
- TF Legacy
- Install
- Upgrade
- Req Config
- Install on Azure
- TF
- TF Legacy
- Install
- Upgrade
- Req Config
- ...
- Upgrading
- Install on kind
So ... we might want to go:
- Self-Managed Deployments
- Install
- Install on kind
- Install on AWS
- ...
- Upgrade <-- This can be the separate landing page overview.
- Upgrade on kind
- Upgrade on AWS
- ...
- Install
jubrad
changed the title
jubrad
force-pushed
the
jubrad/new-terraform-docs-2
branch
from
c1937ea to
c3bf896
Compare
- Moves the install, upgrade, and configuration docs into a subdirectory called Terraform Provider (Legacy) - Creates aliases for each of the moved pages - `Installation > Install on GCP `-> `Installation > Install on GCP > Terraform Provider (Legacy) > Install` - Removed terraform references from the Deployment guideline appendix and pushed them into the Configuration appendix - Changed from "Required configuration" to just "configuration" docs: Relabel AWS guides as legacy Terraform guides - Does the same work as the GCP commit docs: Relabel Azure guides as legacy Terraform guides - Does the same thing as the GCP commit - Removes terraform configuation values given they weren't rendered. e.g. enable_disk_support Update doc links Add docs for new terraform modules.
jubrad
force-pushed
the
jubrad/new-terraform-docs-2
branch
3 times, most recently
from
4ce9781 to
09c8029
Compare
jubrad
force-pushed
the
jubrad/new-terraform-docs-2
branch
from
09c8029 to
718192a
Compare
3 participants
Motivation
Revival of Jun's Pr to shift the cloud specific terraform install and upgrade structure +docs for the new terraform.