Skip to content

Commit 40d1d84

Browse files
committed
docs: Add console create new page
1 parent 881685e commit 40d1d84

File tree

6 files changed

+152
-4
lines changed

6 files changed

+152
-4
lines changed

Diff for: doc/user/content/console/_index.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,14 @@ view billing information.
1717
![Image of the Materialize Console](/images/console/console.png
1818
"Materialize Console")
1919

20-
- **Create New**: Shortcut menu to the **New Cluster**, **Create a
21-
Source**, and **New app password** screens.
20+
- **Create New**: Shortcut menu to the following screens:
21+
22+
- [**New cluster**](/console/create-new/#create-new-cluster) screens
23+
24+
- [**New source**](/console/create-new/#create-new-source) screens
25+
26+
- [**New app password**](/console/create-new/#create-new-app-password) screens
27+
2228

2329
- [SQL Shell](/console/sql-shell/): Issue SQL queries.
2430

Diff for: doc/user/content/console/admin.md

+13-2
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,25 @@ The **Admin** section contains the following screens:
1717

1818
| Feature | Description |
1919
|---------|-------------|
20-
| **App Passwords** | Manage client credentials to allow your applications and services to connect to Materialize. |
20+
| **App Passwords** | View or delete client credentials that allow your applications and services to connect to Materialize. |
2121
| **Billing** | Access detailed usage and billing information as well as your invoices. <br>**Available for administrators only.** |
2222

2323
### App Passwords
2424

2525
![Image of the Client Passwords](/images/console/console-passwords.png "Client passwords")
2626

27-
The [**Connect**](/console/connect/) button provides details needed to connect to Materialize.
27+
The **App Passwords** screen displays the various [client credentials
28+
created](/console/create-new/#create-new-app-password) to allow your
29+
applications and services to connect to Materialize.
30+
31+
- The [**Connect**](/console/connect/) button provides details needed to connect
32+
to Materialize.
33+
34+
- The **trash can** button deletes the password.
35+
36+
See also [+Create New > App
37+
Password](/console/create-new/#create-new-app-password) for steps to create a
38+
new app password.
2839

2940
### Billing page
3041

Diff for: doc/user/content/console/create-new.md

+131
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
---
2+
title: "Create new"
3+
description: "Create new clusters, sources, and application passwords in the Materialize console"
4+
menu:
5+
main:
6+
parent: console
7+
weight: 6
8+
identifier: console-create-new
9+
---
10+
11+
From the Console, you can create new [clusters](/concepts/clusters/ "Isolated
12+
pools of compute resources (CPU, memory, and scratch disk space)"),
13+
[sources](/concepts/sources/ "Upstream (i.e., external) systems you want
14+
Materialize to read data from"), and application passwords.
15+
16+
### Create new cluster
17+
18+
![Image of the Create New Cluster flow](/images/console/console-create-new/postgresql/create-new-cluster-flow.png "Create New Cluster flow")
19+
20+
From the [Materialize console](https://console.materialize.com/):
21+
22+
1. Click **+ Create New** and select **Cluster** to open the **New cluster**
23+
screen.
24+
25+
1. In the **New cluster** screen,
26+
27+
1. Specify the following cluster information:
28+
29+
| Field | Description |
30+
| ----- | ----------- |
31+
| **Name** | A name for the cluster. | `
32+
| **Size** | The [size](/sql/create-cluster/#size) of the cluster. |
33+
| **Replica** | The [replication factor](/sql/create-cluster/#replication-factor) of the cluster. Default: `1` <br>Clusters that contain sources or sinks cannot have a replication factor greater than 1.|
34+
35+
1. Click **Create cluster** to create the cluster.
36+
37+
1. Upon successful creation, you'll be redirected to the **Overview** page of
38+
the newly created cluster.
39+
40+
41+
### Create new source
42+
43+
{{< tip >}}
44+
45+
- For PostgreSQL and MySQL, you must configure your upstream database first.
46+
Refer to the [Ingest data](/ingest-data/) section for your data source.
47+
48+
- For information about the snapshotting process that occurs when a new source
49+
is created as well as some best practice guidelines, see [Ingest
50+
data](/ingest-data/).
51+
52+
{{</ tip >}}
53+
54+
![Image of the Create New Source start for
55+
PostgreSQL](/images/console/console-create-new/postgresql/create-new-source-start.png
56+
"Create New Source start for PostgreSQL")
57+
58+
From the [Materialize console](https://console.materialize.com/):
59+
60+
1. Click **+ Create New** and select **Source** to open the **New source**
61+
screen.
62+
63+
1. Choose the source type and follow the instructions to configure a new source.
64+
65+
{{< tip >}}
66+
67+
For PostgreSQL and MySQL, you must configure your upstream database first. Refer
68+
to the [Ingest data](/ingest-data/) section for your data source.
69+
70+
{{</ tip >}}
71+
72+
73+
### Create new app password
74+
75+
![Image of the Create application
76+
password](/images/console/console-create-new/create-app-password.png "Create
77+
application password")
78+
79+
1. Click **+ Create New** and select **App Password** to open the **New app
80+
password** modal.
81+
82+
1. In the **New app password** modal, specify the **Type** (either **Personal**
83+
or **Service**) and the associated details:
84+
85+
{{< note >}}
86+
87+
- **Personal** apps are run under your user account.
88+
- **Service** apps are run under a Service account. If the specified Service
89+
account does not exist, it will be automatically created the **first time**
90+
the app password is used.
91+
92+
{{</ note >}}
93+
94+
95+
{{< tabs >}}
96+
{{< tab "Personal" >}}
97+
98+
For a personal app that you will run under your user account, specify the
99+
type and required field(s):
100+
101+
| Type | Details |
102+
| ---- | ----------- |
103+
| **Type** | Select **Personal** |
104+
| **Name** | Specify a descriptive name. |
105+
106+
107+
{{</ tab >}}
108+
{{< tab "Service account" >}}
109+
110+
For an app that you will run under a Service account, specify the
111+
type and required field(s):
112+
113+
114+
| Field | Details |
115+
| ----- | ----------- |
116+
| **Type** | Select **Personal** |
117+
| **Name** | Specify a descriptive name. |
118+
| **User** | Specify the service account user name. If the specifie account does not exist, it will be automatically created the **first time** the application password is used. |
119+
| **Roles** | Select the roles to associate with the account. <br><br><ul><li><strong>Organization Admin</strong> has _superuser_ privileges in the database.</li><li><strong>Organization Member</strong> has restricted access to the database, depending on the privileges defined via [role-based access control (RBAC)](/manage/access-control/#role-based-access-control-rbac). |
120+
121+
See also [Create service
122+
accounts](/manage/access-control/create-service-accounts/) for creating
123+
service accounts via Terraform.
124+
125+
{{</ tab >}}
126+
{{</ tabs >}}
127+
128+
1. Click **Create password** to create the app password.
129+
130+
To view the created application passwords, go to [Admin > App
131+
Passwords](/console/admin/).
Loading
Loading
Loading

0 commit comments

Comments
 (0)