-
Notifications
You must be signed in to change notification settings - Fork 467
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
docs: Draft docs for self-managed (WIP) #30491
Merged
kay-kim
merged 19 commits into
MaterializeInc:main
from
kay-kim:docs-self-hosted-draft-for-meeting
Dec 12, 2024
Merged
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
3495b49
docs: Draft docs for self-hosted (WIP)
kay-kim 10a65be
docs: Add install locally on kind
kay-kim 1571ceb
Add install on minikube + rename to self managed + reorg
kay-kim dba82c1
fix lint errors
kay-kim e49bd3e
rm required column from config table
kay-kim 74171d8
add robots=noindex,nofollow to self-managed docs
kay-kim 885eb7c
Add more stub content to AWS/GCP pages
kay-kim 6746ea4
fix lint errors - gah, ai
kay-kim f2d4c91
Use https instead of http for localhost
kay-kim caec908
updates in prep for 0.127.0
kay-kim c57c4f4
temp
kay-kim dda6856
add display field to the data file + move EBS/NVMe stuff to operation…
kay-kim 198dba1
tweaks
kay-kim 8bd58e4
tweak: make latest version a data file
kay-kim 2430bf1
update parameter's image.tag
kay-kim d0a1603
use the parameters to figure out which image version to checkout
kay-kim dda9051
tweaks
kay-kim ccd24c7
Update with latest configuration changes
kay-kim 1cb9554
fix lint errors
kay-kim 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 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,58 @@ | ||
--- | ||
title: "Self-managed Materialize" | ||
description: "" | ||
aliases: | ||
- /self-hosted/ | ||
robots: "noindex, nofollow" | ||
--- | ||
|
||
With self-managed Materialize, you can deploy and operate Materialize in your | ||
Kubernetes environment. For self-managed Materialize, Materialize offers: | ||
|
||
- A Kubernetes Operator that manages your Materialize running in your Kubernetes | ||
environment. | ||
|
||
- Materialize packaged as a containerized application that can be deployed in a | ||
Kubernetes cluster. | ||
|
||
## Requirements | ||
|
||
The self-managed Materialize requires the following: | ||
|
||
- Kubernetes (v1.19+) environment. | ||
|
||
- PostgreSQL or CockroachDB as a metadata database. | ||
|
||
- Blob storage. | ||
|
||
See the [Installation guide](/self-managed/installation/) for more information. | ||
|
||
## Recommended instance types | ||
|
||
Materialize has been tested to work on instances with the following properties: | ||
|
||
- ARM-based CPU | ||
- 1:8 ratio of vCPU to GiB memory | ||
- 1:16 ratio of vCPU to GiB local instance storage (if enabling spill-to-disk) | ||
|
||
For specific cloud provider recommendations, see the [Installation guide for the | ||
cloud provider](/self-managed/installation/) as well as the [operational guidelines](/self-managed/operational-guidelines/). | ||
|
||
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. We could also make this:
|
||
## Installation | ||
|
||
For instructions on installing Materialize on your Kubernetes cluster, see: | ||
|
||
- [Install locally on kind](/self-managed/installation/install-on-local-kind/) | ||
|
||
- [Install locally on | ||
minikube](/self-managed/installation/install-on-local-minikube/) | ||
|
||
- [Install on AWS](/self-managed/installation/install-on-aws/) | ||
- [Install on GCP](/self-managed/installation/install-on-gcp/) | ||
|
||
## Related pages | ||
|
||
<!-- Temporary: | ||
Hugo will add links to the pages in the same folder. | ||
Since we're hiding this section from the left-hand nav, adding the links here. | ||
--> |
This file contains 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,62 @@ | ||
--- | ||
title: "Materialize Operator Configuration" | ||
description: "" | ||
aliases: | ||
- /self-hosted/configuration/ | ||
robots: "noindex, nofollow" | ||
--- | ||
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. |
||
|
||
You can configure the Materialize operator chart. For example: | ||
|
||
- **RBAC** | ||
|
||
The chart creates a `ClusterRole` and `ClusterRoleBinding` by default. | ||
|
||
- **Network Policies** | ||
|
||
Network policies can be enabled by setting | ||
[`networkPolicies.enabled=true`](/self-managed/configuration/#networkpoliciesenabled). | ||
By default, the chart uses native Kubernetes network policies. For additional network policy configuration options, see [`networkPolicies` parameters](#networkpolicies-parameters). | ||
|
||
- **Observability** | ||
|
||
To enable observability features, set | ||
[`observability.enabled=true`](/self-managed/configuration/#observabilityenabled). | ||
This will create the necessary resources for monitoring the operator. For | ||
additional observability configuraiton options, see [`observability` | ||
parameters](#observability-parameters). | ||
|
||
## Configure the Materialize operator chart | ||
|
||
To configure the Materialize operator chart, you can: | ||
|
||
- *Recommended:* Modify the provided `values.yaml` file (or create your own | ||
YAML file) that specifies the configuration values and then install the | ||
chart with the `-f` flag: | ||
|
||
```shell | ||
helm install my-materialize-operator -f /path/to/values.yaml /path/to/materialize/helm-charts/operator | ||
``` | ||
|
||
- Specify each parameter using the `--set key=value[,key=value]` argument to | ||
`helm install`. For example: | ||
|
||
```shell | ||
helm install my-materialize-operator \ | ||
--set operator.image.tag=v1.0.0 \ | ||
/path/to/materialize/helm-charts/operator | ||
``` | ||
|
||
{{% self-managed/materialize-operator-chart-parameters-table %}} | ||
|
||
## Parameters | ||
|
||
{{% self-managed/materialize-operator-chart-parameters %}} | ||
|
||
## See also | ||
|
||
- [Materialize Kubernetes Operator Helm Chart](/self-managed/) | ||
- [Troubleshooting](/self-managed/troubleshooting/) | ||
- [Installation](/self-managed/installation/) | ||
- [Operational guidelines](/self-managed/operational-guidelines/) | ||
- [Upgrading](/self-managed/upgrading/) |
This file contains 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,25 @@ | ||
--- | ||
title: "Installation" | ||
description: "Installation guides for self-managed Materialize." | ||
robots: "noindex, nofollow" | ||
disable_list: true | ||
--- | ||
|
||
## Install locally | ||
|
||
- [Install locally on kind](/self-managed/installation/install-on-local-kind/) | ||
|
||
- [Install locally on minikube](/self-managed/installation/install-on-local-minikube/) | ||
|
||
## Install on cloud provider | ||
|
||
- [Install on AWS](/self-managed/installation/install-on-aws/) | ||
- [Install on GCP](/self-managed/installation/install-on-gcp/) | ||
|
||
## See also | ||
|
||
- [Materialize Kubernetes Operator Helm Chart](/self-managed/) | ||
- [Materialize Operator Configuration](/self-managed/configuration/) | ||
- [Troubleshooting](/self-managed/troubleshooting/) | ||
- [Operational guidelines](/self-managed/operational-guidelines/) | ||
- [Upgrading](/self-managed/upgrading/) |
Oops, something went wrong.
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.
https://preview.materialize.com/materialize/30491/self-managed/