Skip to content

Commit 41a46a9

Browse files
authored
docs: install cloud use v0.130.0 (#31105)
1 parent 284e4fb commit 41a46a9

File tree

2 files changed

+30
-56
lines changed

2 files changed

+30
-56
lines changed

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

Lines changed: 23 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -82,35 +82,17 @@ for evaluation purposes only. The module deploys a sample infrastructure on AWS
8282
1. Clone or download the [Materialize's sample Terraform
8383
repo](https://github.com/MaterializeInc/terraform-aws-materialize).
8484

85-
1. Go to the Materialize Terraform repo directory.
85+
1. Go to the `examples/simple` folder in the Materialize Terraform repo
86+
directory.
8687

8788
```bash
88-
cd terraform-aws-materialize
89+
cd terraform-aws-materialize/examples/simple
8990
```
9091

91-
1. Copy the `terraform.tfvars.example` file to `terraform.tfvars`.
92+
1. Create a `terraform.tfvars` file and specify a database password.
9293

9394
```bash
94-
cp terraform.tfvars.example terraform.tfvars
95-
```
96-
97-
1. Edit the `terraform.tfvars` file to set the values for your AWS environment.
98-
In particular,
99-
100-
- set your `database_password` to a secure password.
101-
- set your `node_group_ami_type` to a `"AL2023_ARM_64_STANDARD"`.
102-
- set your `node_group_instance_types` to a supported instance type for
103-
ARM64.
104-
- set your `service_account_name` to a name for your Materialize.
105-
106-
107-
```bash
108-
109-
# resources are prefixed with ${namespace}-${environment}
110-
namespace = "enter-your-namespace" # Enter a namespace
111-
environment = "enter-your-environment" # Enter an environment name
11295
database_password = "enter-your-secure-password" # Enter a secure password
113-
11496
```
11597

11698
1. Initialize the terraform directory.
@@ -138,13 +120,13 @@ for evaluation purposes only. The module deploys a sample infrastructure on AWS
138120
Apply complete! Resources: 82 added, 0 changed, 0 destroyed.
139121
140122
Outputs:
141-
database_endpoint = "my-test-db.abcdefg8dsto.us-east-1.rds.amazonaws.com:5432"
123+
database_endpoint = "materialize-simple.abcdefg8dsto.us-east-1.rds.amazonaws.com:5432"
142124
eks_cluster_endpoint = "https://0123456789A00BCD000E11BE12345A01.gr7.us-east-1.eks.amazonaws.com"
143-
materialize_s3_role_arn = "arn:aws:iam::000111222333:role/my-test-materialize-s3-role"
125+
materialize_s3_role_arn = "arn:aws:iam::000111222333:role/dev-materialize-s3-role"
144126
metadata_backend_url = <sensitive>
145-
oidc_provider_arn = "arn:aws:iam::000111222333:oidc-provider/oidc.eks. us-east-1.amazonaws.com/id/0123456789A00BCD000E11BE12345A01"
146-
persist_backend_url = "s3://my-test-bucket/my-test:serviceaccount:materialize-environment:my-test-materialize-svc"
147-
s3_bucket_name = "my-test-bucket"
127+
oidc_provider_arn = "arn:aws:iam::000111222333:oidc-provider/oidc.eks.us-east-1.amazonaws.com/id/0123456789A00BCD000E11BE12345A01"
128+
persist_backend_url = "s3://materialize-simple-storage-c2663c2f/dev:serviceaccount:materialize-environment:12345678-1234-1234-1234-123456789012"
129+
s3_bucket_name = "materialize-simple-storage-c2663c2f"
148130
vpc_id = "vpc-0abc000bed1d111bd"
149131
```
150132

@@ -164,16 +146,16 @@ for evaluation purposes only. The module deploys a sample infrastructure on AWS
164146
terraform output -json metadata_backend_url | jq
165147
```
166148

167-
1. Configure `kubectl` to connect to your EKS cluster, replacing:
149+
1. Configure `kubectl` to connect to your EKS cluster.
168150

169-
- `<your-cluster-name>` with the name of your EKS cluster (specified in
170-
`terraform.tfvars`)
151+
- By default, the example Terraform module uses `materialize-eks-simple` as
152+
the name of your EKS cluster.
171153

172-
- `<your-region>` with the region of your EKS cluster. By default, the
173-
sample Terraform module uses `us-east-1`.
154+
- By default, the example Terraform module uses `us-east-1` as the region of
155+
your EKS cluster.
174156

175157
```bash
176-
aws eks update-kubeconfig --name <your-cluster-name> --region <your-region>
158+
aws eks update-kubeconfig --name materialize-eks-simple --region us-east-1
177159
```
178160

179161
To verify that you have configured correctly, run the following command:
@@ -193,16 +175,19 @@ for evaluation purposes only. The module deploys a sample infrastructure on AWS
193175
## B. Install the Materialize Operator
194176

195177
1. Clone/download the [Materialize
196-
repo](https://github.com/MaterializeInc/materialize).
178+
repo](https://github.com/MaterializeInc/materialize). The tutorial uses the
179+
`lts-v0.130` branch.
180+
181+
```sh
182+
git clone --branch lts-v0.130 https://github.com/MaterializeInc/materialize.git
183+
```
197184

198185
1. Go to the Materialize repo directory.
199186

200187
```bash
201188
cd materialize
202189
```
203190

204-
1. Check out the {{% self-managed/latest_version %}} tag.
205-
206191
1. Create a `my-materialize-operator-values.yaml` configuration file for the
207192
Materialize operator. Update with:
208193

@@ -311,17 +296,14 @@ To deploy Materialize:
311296
1. Create a YAML file `my-materialize.yaml` for your Materialize
312297
configuration.
313298

314-
Replace `<your_service_account_name>` with the name you specified in the
315-
`terraform.tfvars` file.
316-
317299
```yaml
318300
apiVersion: materialize.cloud/v1alpha1
319301
kind: Materialize
320302
metadata:
321-
name: "<your_service_account_name>" # e.g. my-test-materialize-svc
303+
name: 12345678-1234-1234-1234-123456789012
322304
namespace: materialize-environment
323305
spec:
324-
environmentdImageRef: materialize/environmentd:v0.127.0
306+
environmentdImageRef: materialize/environmentd:v0.130.0
325307
environmentdResourceRequirements:
326308
limits:
327309
memory: 16Gi

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

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -256,15 +256,19 @@ evaluation purposes only. The module deploys a sample infrastructure on GCP
256256
## B. Install the Materialize Operator
257257
258258
1. Clone/download the [Materialize
259-
repo](https://github.com/MaterializeInc/materialize).
259+
repo](https://github.com/MaterializeInc/materialize). The tutorial uses the
260+
`lts-v0.130` branch.
261+
262+
```sh
263+
git clone --branch lts-v0.130 https://github.com/MaterializeInc/materialize.git
264+
```
260265
261266
1. Go to the Materialize repo directory.
262267
263268
```bash
264269
cd materialize
265270
```
266271
267-
1. Check out the {{% self-managed/latest_version %}} tag.
268272
269273
1. Create a `my-materialize-operator-values.yaml` configuration file for
270274
the Materialize operator. Update with:
@@ -370,19 +374,7 @@ To deploy Materialize:
370374
name: "your-service-account-name" # e.g. my-simple-materialize-sa
371375
namespace: materialize-environment
372376
spec:
373-
environmentdImageRef: materialize/environmentd:v0.127.0
374-
environmentdResourceRequirements:
375-
limits:
376-
memory: 16Gi
377-
requests:
378-
cpu: "2"
379-
memory: 16Gi
380-
balancerdResourceRequirements:
381-
limits:
382-
memory: 256Mi
383-
requests:
384-
cpu: "100m"
385-
memory: 256Mi
377+
environmentdImageRef: materialize/environmentd:v0.130.0
386378
backendSecretName: materialize-backend
387379
```
388380

0 commit comments

Comments
 (0)