Skip to content

Commit 3025670

Browse files
committed
Restore titles with different wording as possible
1 parent 211605e commit 3025670

File tree

4 files changed

+37
-38
lines changed

4 files changed

+37
-38
lines changed

src/content/doc-surrealdb/deployment/amazon.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ echo $SURREALDB_ENDPOINT
302302

303303
Test your connection with the following command:
304304

305-
```bash
305+
```bash title="Connection test"
306306
surreal sql -e https://$SURREALDB_ENDPOINT
307307
>
308308
```
@@ -311,7 +311,7 @@ surreal sql -e https://$SURREALDB_ENDPOINT
311311

312312
Cleanup can be performed with the following commands.
313313

314-
```
314+
```bash title="Cleanup"
315315
kubectl delete -f tidb-monitor.yaml -n tidb-cluster
316316
kubectl delete -f tidb-cluster.yaml -n tidb-cluster
317317
helm uninstall surrealdb-tikv

src/content/doc-surrealdb/deployment/azure.mdx

+15-15
Original file line numberDiff line numberDiff line change
@@ -54,20 +54,20 @@ This tutorial is intended for production workloads using the <code>standard</cod
5454

5555
1. Log in to Azure and get the current subscription if you have multiple subscriptions.
5656

57-
```bash
57+
```bash title="Log in and get subscription"
5858
$ az login
5959
$ az account list
6060
```
6161

6262
2. Create a new resource group:
6363

64-
```bash
64+
```bash title="Create new group"
6565
$ az group create --name rg-surrealdb-aks --location westeurope
6666
```
6767

6868
3. Run the following command to create a new AKS cluster:
6969

70-
```bash
70+
```bash title="Create new cluster"
7171
$ az aks create \
7272
--resource-group rg-surrealdb-aks \
7373
--location westeurope \
@@ -80,9 +80,9 @@ $ az aks create \
8080
--tier standard
8181
```
8282

83-
4. After the creation finishes, get credentials to configure <code>kubectl</code> to connect to the new cluster:
83+
4. After creation finishes, get credentials to configure <code>kubectl</code> to connect to the new cluster:
8484

85-
```bash
85+
```bash title="Get AKS cluster credentials"
8686
$ az aks get-credentials --resource-group rg-surrealdb-aks --name surrealdb-aks-cluster
8787
```
8888

@@ -104,7 +104,7 @@ aks-nodepool1-33674805-vmss000002 Ready agent 2m34s v1.26.6
104104
105105
1. Create a TiDB Operator and monitor pool:
106106

107-
```bash
107+
```bash title="Create operator and monitor"
108108
$ az aks nodepool add --name admin \
109109
--resource-group rg-surrealdb-aks \
110110
--cluster-name surrealdb-aks-cluster \
@@ -115,7 +115,7 @@ $ az aks nodepool add --name admin \
115115

116116
2. Create a PD node pool:
117117

118-
```bash
118+
```bash title="Add node pool"
119119
$ az aks nodepool add --name pd \
120120
--resource-group rg-surrealdb-aks \
121121
--cluster-name surrealdb-aks-cluster \
@@ -128,7 +128,7 @@ $ az aks nodepool add --name pd \
128128

129129
3. Create a TiKV node pool:
130130

131-
```bash
131+
```bash title="Add node pool"
132132
$ az aks nodepool add --name tikv \
133133
--resource-group rg-surrealdb-aks \
134134
--cluster-name surrealdb-aks-cluster \
@@ -148,13 +148,13 @@ You can deploy it following these steps:
148148

149149
1. Install CRDS:
150150

151-
```bash
151+
```bash title="CRDS installation"
152152
$ kubectl create -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.5.0/manifests/crd.yaml
153153
```
154154

155155
2. Install TiDB Operator Helm chart:
156156

157-
```bash
157+
```bash title="Helm chart installation"
158158
$ helm repo add pingcap https://charts.pingcap.org
159159
$ helm repo update
160160
$ helm install \
@@ -262,13 +262,13 @@ spec:
262262
263263
2. Create the TiDB cluster:
264264
265-
```bash
265+
```bash title="Apply TiDB cluster"
266266
$ kubectl apply -f tikv-cluster.yaml
267267
```
268268

269269
3. Check the cluster status and wait until it's ready:
270270

271-
```bash
271+
```bash title="Verify TiDB cluster"
272272
$ kubectl get tidbcluster
273273

274274
$ kubectl get pods
@@ -290,7 +290,7 @@ The deployment will use the latest SurrealDB Docker image and make it accessible
290290

291291
1. Get the TiKV PD service URL:
292292

293-
```bash
293+
```bash title="Get service URL"
294294
$ kubectl get service sdb-datastore-pd
295295

296296
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
@@ -301,7 +301,7 @@ $ export TIKV_URL=tikv://sdb-datastore-pd:2379
301301

302302
2. Install the SurrealDB Helm chart with the TIKV_URL defined above and with auth disabled so we can create the initial credentials:
303303

304-
```bash
304+
```bash title="SurrealDB Helm chart installation"
305305
$ helm repo add surrealdb https://helm.surrealdb.com
306306
$ helm repo update
307307
$ helm install \
@@ -326,7 +326,7 @@ surrealdb-tikv LoadBalancer 10.0.38.191 20.13.45.154 80:30378/TCP 6m34
326326

327327
4. Connect to the cluster and define the initial credentials:
328328

329-
```bash
329+
```bash title="Connect and define credentials"
330330
$ export SURREALDB_URL=http://$(kubectl get service surrealdb-tikv -o json | jq -r .status.loadBalancer.ingress[0].ip)
331331

332332
$ surreal sql -e $SURREALDB_URL

src/content/doc-surrealdb/deployment/google.mdx

+11-12
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ gcloud container clusters create-auto surrealdb-guide --region REGION --project
5858

5959
3. After the creation finishes, configure kubectl to connect to the new cluster:
6060

61-
```bash
61+
```bash title="kubectl configuration"
6262
gcloud container clusters get-credentials surrealdb-guide --region REGION --project PROJECT_ID
6363
```
6464

@@ -70,15 +70,14 @@ You can deploy it following these steps:
7070

7171
1. Install CRDS:
7272

73-
```bash
73+
```bash title="CRDS installation"
7474
kubectl create -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.5.0/manifests/crd.yaml
7575
```
7676

7777
2. Install TiDB operator Helm chart:
7878

7979

80-
```bash
81-
80+
```bash title="Helm chart installation"
8281
$ helm repo add pingcap https://charts.pingcap.org
8382
$ helm repo update
8483
$ helm install \
@@ -90,7 +89,7 @@ $ helm install \
9089
```
9190
3. Verify that the Pods are running:
9291

93-
```bash
92+
```bash title="Get pod status"
9493
kubectl get pods --namespace tidb-operator -l app.kubernetes.io/instance=tidb-operator
9594
NAME READY STATUS RESTARTS AGE
9695
tidb-controller-manager-56f49794d7-hnfz7 1/1 Running 0 20s
@@ -184,13 +183,13 @@ spec:
184183
185184
2. Create the TiDB cluster:
186185
187-
```bash
186+
```bash title="Apply cluster def"
188187
kubectl apply -f tikv-cluster.yaml
189188
```
190189

191190
3. Check the cluster status and wait until it’s ready:
192191

193-
```bash
192+
```bash title="Get status for cluster"
194193
kubectl get tidbcluster
195194
NAME READY PD STORAGE READY DESIRE TIKV STORAGE READY DESIRE TIDB READY DESIRE AGE
196195
sdb-datastore True pingcap/pd:v6.5.0 10Gi 3 3 pingcap/tikv:v6.5.0 10Gi 3 3 pingcap/tidb:v6.5.0 0 5m
@@ -204,7 +203,7 @@ The deployment will use the latest SurrealDB Docker image and make it accessible
204203

205204
1. Get the TiKV PD service URL:
206205

207-
```bash
206+
```bash title="get TiKV URL"
208207
kubectl get svc/sdb-datastore-pd
209208
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
210209
sdb-datastore-pd ClusterIP 10.96.208.25 <none> 2379/TCP 10h
@@ -213,7 +212,7 @@ export TIKV_URL=tikv://sdb-datastore-pd:2379
213212
```
214213
2. Install the SurrealDB Helm chart with the TIKV_URL defined above and with auth disabled so we can create the initial credentials:
215214

216-
```bash
215+
```bash title="Install Helm chart"
217216
helm repo add surrealdb https://helm.surrealdb.com
218217
$ helm repo update
219218
$ helm install \
@@ -226,23 +225,23 @@ $ helm install \
226225

227226
3. Wait until the Ingress resource has an `ADDRESS` assigned:
228227

229-
```bash
228+
```bash title="Wait for Ingress ADDRESS"
230229
kubectl get ingress surrealdb-tikv
231230
NAME CLASS HOSTS ADDRESS PORTS AGE
232231
surrealdb-tikv <none> * 34.160.82.177 80 5m
233232
```
234233

235234
4. Connect to the cluster and define the initial credentials:
236235

237-
```bash
236+
```bash title="Connect then define user"
238237
$ export SURREALDB_URL=http://$(kubectl get ingress surrealdb-tikv -o json | jq -r .status.loadBalancer.ingress[0].ip)
239238
$ surreal sql -e $SURREALDB_URL
240239
> DEFINE USER root ON ROOT PASSWORD 'StrongSecretPassword!' ROLES OWNER;
241240
```
242241

243242
5. Verify you can connect to the database with the new credentials:
244243

245-
```bash
244+
```bash title="Connect as defined user"
246245
$ surreal sql -u root -p 'StrongSecretPassword!' -e $SURREALDB_URL
247246
> INFO FOR ROOT
248247
[{ accesses: { }, namespaces: { }, nodes: { "0e87c953-68d7-40e1-9090-3dfc404af25e": 'NODE 0e87c953-68d7-40e1-9090-3dfc404af25e SEEN 1742869518357 ACTIVE' }, system: { available_parallelism: 14, cpu_usage: 4.321133613586426f, load_average: [2.2265625f, 2.2138671875f, 2.044921875f], memory_allocated: 13428527, memory_usage: 154812416, physical_cores: 14, threads: 32 }, users: { root: "DEFINE USER root ON ROOT PASSHASH '...' ROLES OWNER DURATION FOR TOKEN 1h, FOR SESSION NONE" } }]

src/content/doc-surrealdb/deployment/kubernetes.mdx

+9-9
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ First, we need to create a [`KIND`](https://kind.sigs.k8s.io/) cluster. KIND is
4242

4343
Run the following command to create a cluster:
4444

45-
```bash
45+
```bash title="Create new cluster"
4646
kind create cluster -n surreal-demo
4747
```
4848

4949
### 2. Verify interaction with cluster
5050

5151
Run the following command to verify that we can interact with the created cluster:
5252

53-
```bash
53+
```bash title="Verify cluster"
5454
kubectl config current-context
5555
```
5656

@@ -87,7 +87,7 @@ You can deploy it following these steps:
8787

8888
1. Install CRDS:
8989

90-
```bash
90+
```bash title="CRDS installation"
9191
kubectl create -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.4.5/manifests/crd.yaml
9292
```
9393

@@ -106,7 +106,7 @@ helm install \
106106

107107
3. Verify that the pods are running:
108108

109-
```bash
109+
```bash title="Get pod status"
110110
kubectl get pods --namespace tidb-operator -l app.kubernetes.io/instance=tidb-operator
111111
```
112112

@@ -137,14 +137,14 @@ kubectl create ns tikv
137137

138138
Run the following command to create the TiDB cluster:
139139

140-
```bash
140+
```bash title="TiDB cluster creation"
141141
kubectl apply -n tikv -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.4.5/examples/basic/tidb-cluster.yaml
142142
```
143143
### 3. Check cluster status
144144

145145
Run the following command to check the cluster status and wait until it’s ready:
146146

147-
```bash
147+
```bash title="Verify TiDB cluster"
148148
kubectl get -n tikv tidbcluster
149149
```
150150

@@ -167,7 +167,7 @@ For this guide, we will use the SurrealDB Helm chart. Run the following commands
167167

168168
Run the following command to add the SurrealDB Charts repository:
169169

170-
```bash
170+
```bash title="Add Helm repository"
171171
helm repo add surrealdb https://helm.surrealdb.com
172172
helm repo update
173173
```
@@ -176,7 +176,7 @@ helm repo update
176176

177177
Run the following command to get the TiKV PD service URL:
178178

179-
```bash
179+
```bash title="Get TiKV URL"
180180
kubectl get -n tikv svc/basic-pd
181181
```
182182

@@ -189,7 +189,7 @@ basic-pd ClusterIP 10.96.208.25 <none> 2379/TCP 10h
189189

190190
Then set the TIKV_URL variable to the PD service URL:
191191

192-
```bash
192+
```bash title="Set TIKV_URL var"
193193
export TIKV_URL=tikv://basic-pd.tikv:2379
194194
```
195195

0 commit comments

Comments
 (0)