Skip to content

Commit 6303751

Browse files
authored
reorg release notes and remove minikube install + tweaks (#34122)
1 parent 0873e20 commit 6303751

File tree

14 files changed

+74
-427
lines changed

14 files changed

+74
-427
lines changed

doc/user/content/installation/install-on-aws/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Install on AWS"
2+
title: "Install on AWS (via Terraform)"
33
description: ""
44
aliases:
55
- /self-hosted/install-on-aws/

doc/user/content/installation/install-on-aws/appendix-deployment-guidelines.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,21 @@ when operating on datasets larger than main memory as well as allows for a more
3333
graceful degradation rather than OOMing. Network-attached storage (like EBS
3434
volumes) can significantly degrade performance and is not supported.
3535

36+
### Swap support
37+
3638
Starting in v0.6.1 of Materialize on AWS Terraform,
37-
disk support (using swap on NVMe instance storage) may be enabled for Materialize.
38-
With this change, the Terraform:
39+
disk support (using swap on NVMe instance storage) may be enabled for
40+
Materialize. With this change, the Terraform:
3941

4042
- Creates a node group for Materialize.
4143
- Configures NVMe instance store volumes as swap using a daemonset.
4244
- Enables swap at the Kubelet.
4345

44-
- The following configuration options are available:
46+
For swap support, the following configuration option is available:
4547

46-
- [`swap_enabled`]
48+
- [`swap_enabled`](https://github.com/MaterializeInc/terraform-aws-materialize?tab=readme-ov-file#input_swap_enabled)
4749

48-
See [Upgrade Notes](https://github.com/MaterializeInc/terraform-aws-materialize?tab=readme-ov-file#v061)
50+
See [Upgrade Notes](https://github.com/MaterializeInc/terraform-aws-materialize?tab=readme-ov-file#v061).
4951

5052

5153
## CPU affinity

doc/user/content/installation/install-on-azure/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Install on Azure"
2+
title: "Install on Azure (via Terraform)"
33
description: "Install Materialize on Azure Kubernetes Service (AKS) using Terraform"
44
disable_list: true
55
menu:

doc/user/content/installation/install-on-azure/appendix-deployment-guidelines.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,19 +47,21 @@ when operating on datasets larger than main memory as well as allows for a more
4747
graceful degradation rather than OOMing. Network-attached storage (like EBS
4848
volumes) can significantly degrade performance and is not supported.
4949

50+
### Swap support
51+
5052
Starting in v0.6.1 of Materialize on Azure Terraform,
51-
disk support (using swap on NVMe instance storage) may be enabled for Materialize.
52-
With this change, the Terraform:
53+
disk support (using swap on NVMe instance storage) may be enabled for
54+
Materialize. With this change, the Terraform:
5355

54-
- Creates a node group for Materialize.
55-
- Configures NVMe instance store volumes as swap using a daemonset.
56-
- Enables swap at the Kubelet.
56+
- Creates a node group for Materialize.
57+
- Configures NVMe instance store volumes as swap using a daemonset.
58+
- Enables swap at the Kubelet.
5759

58-
- The following configuration options are available:
60+
For swap support, the following configuration option is available:
5961

60-
- [`swap_enabled`]
62+
- [`swap_enabled`](https://github.com/MaterializeInc/terraform-azurerm-materialize?tab=readme-ov-file#input_swap_enabled)
6163

62-
See [Upgrade Notes](https://github.com/MaterializeInc/terraform-azurerm-materialize?tab=readme-ov-file#v061)
64+
See [Upgrade Notes](https://github.com/MaterializeInc/terraform-azurerm-materialize?tab=readme-ov-file#v061).
6365

6466
## Recommended Azure Blob Storage
6567

doc/user/content/installation/install-on-gcp/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Install on GCP"
2+
title: "Install on GCP (via Terraform)"
33
description: ""
44
aliases:
55
- /self-hosted/install-on-gcp/

doc/user/content/installation/install-on-gcp/appendix-deployment-guidelines.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,19 +75,21 @@ when operating on datasets larger than main memory as well as allows for a more
7575
graceful degradation rather than OOMing. Network-attached storage (like EBS
7676
volumes) can significantly degrade performance and is not supported.
7777

78+
### Swap support
79+
7880
Starting in v0.6.1 of Materialize on Google Cloud PRovider (GCP) Terraform,
79-
disk support (using swap on NVMe instance storage) may be enabled for Materialize.
80-
With this change, the Terraform:
81+
disk support (using swap on NVMe instance storage) may be enabled for
82+
Materialize. With this change, the Terraform:
8183

8284
- Creates a node group for Materialize.
8385
- Configures NVMe instance store volumes as swap using a daemonset.
8486
- Enables swap at the Kubelet.
8587

86-
- The following configuration options are available:
88+
For swap support, the following configuration options are available:
8789

88-
- [`swap_enabled`]
90+
- [`swap_enabled`](https://github.com/MaterializeInc/terraform-google-materialize?tab=readme-ov-file#input_swap_enabled)
8991

90-
See [Upgrade Notes](https://github.com/MaterializeInc/terraform-google-materialize?tab=readme-ov-file#v061)
92+
See [Upgrade Notes](https://github.com/MaterializeInc/terraform-google-materialize?tab=readme-ov-file#v061).
9193

9294
## CPU affinity
9395

doc/user/content/installation/install-on-local-kind/_index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
2-
title: "Install locally on kind"
2+
title: "Install locally on kind (via Helm)"
33
description: "Deploy Self-managed Materialize to a local kind cluster."
44
aliases:
55
- /self-hosted/install-on-local-kind/
6+
- /installation/install-on-local-minikube/
67
menu:
78
main:
89
parent: "installation"

doc/user/content/installation/install-on-local-kind/upgrade-on-local-kind.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ menu:
55
main:
66
parent: "install-on-local-kind"
77
identifier: "upgrade-on-local-kind"
8+
aliases:
9+
- /installation/install-on-local-minikube/upgrade-on-local-minikube/
810
---
911

1012
To upgrade your Materialize instances, first choose a new operator version and upgrade the Materialize operator. Then, upgrade your Materialize instances to the same version. The following tutorial upgrades your Materialize deployment running locally on a [`kind`](https://kind.sigs.k8s.io/)

0 commit comments

Comments
 (0)