Skip to content

Commit a1bc007

Browse files
authored
Fix ServiceTemplate docs for MariaDB (#820)
Signed-off-by: SK Ali Arman <arman@appscode.com>
1 parent 5d10523 commit a1bc007

File tree

10 files changed

+48
-34
lines changed

10 files changed

+48
-34
lines changed

docs/guides/ignite/concepts/ignite.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -183,11 +183,11 @@ If a service account name is given, and there's an existing service account by t
183183

184184
`spec.resources` is an optional field. This can be used to request compute resources required by the database pods. To learn more, visit [here](http://kubernetes.io/docs/user-guide/compute-resources/).
185185

186-
### spec.serviceTemplate
186+
### spec.serviceTemplates
187187

188-
You can also provide a template for the services created by KubeDB operator for Ignite server through `spec.serviceTemplate`. This will allow you to set the type and other properties of the services.
188+
You can also provide a template for the services created by KubeDB operator for Ignite server through `spec.serviceTemplates`. This will allow you to set the type and other properties of the services.
189189

190-
KubeDB allows following fields to set in `spec.serviceTemplate`:
190+
KubeDB allows following fields to set in `spec.serviceTemplates`:
191191

192192
- `alias` represents the identifier of the service. It has the following possible value:
193193
- `primary` is used for the primary service identification.

docs/guides/mariadb/concepts/mariadb/index.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -330,11 +330,11 @@ for: "./mariadb.yaml": admission webhook "mariadb.validators.kubedb.com" denied
330330

331331
If a service account name is given, and there's an existing service account by that name, the KubeDB operator will use that existing service account. Since this service account is not managed by KubeDB, users are responsible for providing necessary access permissions manually.
332332

333-
### spec.serviceTemplate
333+
### spec.serviceTemplates
334334

335-
You can also provide a template for the services created by KubeDB operator for MariaDB database through `spec.serviceTemplate`. This will allow you to set the type and other properties of the services.
335+
You can also provide a template for the services created by KubeDB operator for MariaDB database through `spec.serviceTemplates`. This will allow you to set the type and other properties of the services.
336336

337-
KubeDB allows following fields to set in `spec.serviceTemplate`:
337+
KubeDB allows following fields to set in `spec.serviceTemplates`:
338338

339339
- metadata:
340340
- annotations
@@ -349,6 +349,20 @@ KubeDB allows following fields to set in `spec.serviceTemplate`:
349349
- healthCheckNodePort
350350
- sessionAffinityConfig
351351

352+
```bash
353+
spec:
354+
version: "10.6.16"
355+
serviceTemplates:
356+
- alias: primary
357+
metadata:
358+
annotations:
359+
kubedb.com/test-annotation: "test"
360+
spec:
361+
type: LoadBalancer
362+
ports:
363+
- port: 3306
364+
```
365+
352366
See [here](https://github.com/kmodules/offshoot-api/blob/kubernetes-1.16.3/api/v1/types.go#L163) to understand these fields in detail.
353367

354368
### spec.halted

docs/guides/memcached/concepts/memcached.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -210,11 +210,11 @@ If a service account name is given, and there's an existing service account by t
210210

211211
`spec.resources` is an optional field. This can be used to request compute resources required by the database pods. To learn more, visit [here](http://kubernetes.io/docs/user-guide/compute-resources/).
212212

213-
### spec.serviceTemplate
213+
### spec.serviceTemplates
214214

215-
You can also provide a template for the services created by KubeDB operator for Memcached server through `spec.serviceTemplate`. This will allow you to set the type and other properties of the services.
215+
You can also provide a template for the services created by KubeDB operator for Memcached server through `spec.serviceTemplates`. This will allow you to set the type and other properties of the services.
216216

217-
KubeDB allows following fields to set in `spec.serviceTemplate`:
217+
KubeDB allows following fields to set in `spec.serviceTemplates`:
218218

219219
- `alias` represents the identifier of the service. It has the following possible value:
220220
- `primary` is used for the primary service identification.

docs/guides/mssqlserver/concepts/mssqlserver.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -487,13 +487,13 @@ The following fields are configurable in the `spec.tls` section:
487487
- `encoding` (optional) is the private key cryptography standards (PKCS) encoding for this certificate's private key to be encoded in. If provided, allowed values are "pkcs1" and "pkcs8" standing for PKCS#1 and PKCS#8, respectively. It defaults to PKCS#1 if not specified.
488488

489489

490-
### spec.serviceTemplate
490+
### spec.serviceTemplates
491491

492492
KubeDB creates two different services for each MSSQLServer instance. One of them is a primary service named `<mssqlserver-name>` and points to the MSSQLServer `Primary` pod/node. Another one is a secondary service named `<mssqlserver-name>-secondary` and points to MSSQLServer `secondary` replica pods/nodes.
493493

494-
These `primary` and `secondary` services can be customized using [spec.serviceTemplate](#spec.servicetemplate).
494+
These `primary` and `secondary` services can be customized using [spec.serviceTemplates](#spec.servicetemplate).
495495

496-
You can provide template for the services using `spec.serviceTemplate`. This will allow you to set the type and other properties of the service. If `spec.serviceTemplate` is not provided, KubeDB will create a `primary` service of type `ClusterIP` with minimal settings.
496+
You can provide template for the services using `spec.serviceTemplates`. This will allow you to set the type and other properties of the service. If `spec.serviceTemplates` is not provided, KubeDB will create a `primary` service of type `ClusterIP` with minimal settings.
497497

498498
KubeDB allows following fields to set in `spec.serviceTemplates`:
499499
- `alias` represents the identifier of the service. It has the following possible value:

docs/guides/mysql/concepts/database/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -387,11 +387,11 @@ for: "./mysql.yaml": admission webhook "mysql.validators.kubedb.com" denied the
387387

388388
If a service account name is given, and there's an existing service account by that name, the KubeDB operator will use that existing service account. Since this service account is not managed by KubeDB, users are responsible for providing necessary access permissions manually. Follow the guide [here](/docs/guides/mysql/custom-rbac/index.md) to grant necessary permissions in this scenario.
389389

390-
### spec.serviceTemplate
390+
### spec.serviceTemplates
391391

392-
You can also provide a template for the services created by KubeDB operator for MySQL database through `spec.serviceTemplate`. This will allow you to set the type and other properties of the services.
392+
You can also provide a template for the services created by KubeDB operator for MySQL database through `spec.serviceTemplates`. This will allow you to set the type and other properties of the services.
393393

394-
KubeDB allows following fields to set in `spec.serviceTemplate`:
394+
KubeDB allows following fields to set in `spec.serviceTemplates`:
395395

396396
- metadata:
397397
- annotations

docs/guides/percona-xtradb/concepts/perconaxtradb/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -319,11 +319,11 @@ for: "./perconaxtradb.yaml": admission webhook "perconaxtradb.validators.kubedb.
319319

320320
If a service account name is given, and there's an existing service account by that name, the KubeDB operator will use that existing service account. Since this service account is not managed by KubeDB, users are responsible for providing necessary access permissions manually.
321321

322-
### spec.serviceTemplate
322+
### spec.serviceTemplates
323323

324-
You can also provide a template for the services created by KubeDB operator for PerconaXtraDB database through `spec.serviceTemplate`. This will allow you to set the type and other properties of the services.
324+
You can also provide a template for the services created by KubeDB operator for PerconaXtraDB database through `spec.serviceTemplates`. This will allow you to set the type and other properties of the services.
325325

326-
KubeDB allows following fields to set in `spec.serviceTemplate`:
326+
KubeDB allows following fields to set in `spec.serviceTemplates`:
327327

328328
- metadata:
329329
- annotations

docs/guides/pgbouncer/concepts/pgbouncer.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -225,13 +225,13 @@ At least one of the following was changed:
225225

226226
`spec.podTemplate.spec.nodeSelector` is an optional field that specifies a map of key-value pairs. For the pod to be eligible to run on a node, the node must have each of the indicated key-value pairs as labels (it can have additional labels as well). To learn more, see [here](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector) .
227227

228-
### spec.serviceTemplate
228+
### spec.serviceTemplates
229229

230230
KubeDB creates a service for each PgBouncer instance. The service has the same name as the `pgbouncer.name` and points to pgbouncer pods.
231231

232-
You can provide template for this service using `spec.serviceTemplate`. This will allow you to set the type and other properties of the service. If `spec.serviceTemplate` is not provided, KubeDB will create a service of type `ClusterIP` with minimal settings.
232+
You can provide template for this service using `spec.serviceTemplates`. This will allow you to set the type and other properties of the service. If `spec.serviceTemplates` is not provided, KubeDB will create a service of type `ClusterIP` with minimal settings.
233233

234-
KubeDB allows the following fields to set in `spec.serviceTemplate`:
234+
KubeDB allows the following fields to set in `spec.serviceTemplates`:
235235

236236
- metadata:
237237
- annotations

docs/guides/postgres/concepts/postgres-gitops.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -413,15 +413,15 @@ If a service account name is given, and there's an existing service account by t
413413
> Updating `postgres`/`pg-coordinator` containers resources will create a [`VerticalScaling`](/docs/guides/postgres/scaling/vertical-scaling/overview/index.md) OpsRequest by GitOps operator.
414414

415415

416-
### spec.serviceTemplate
416+
### spec.serviceTemplates
417417

418418
KubeDB creates two different services for each Postgres instance. One of them is a master service named `<postgres-name>` and points to the Postgres `Primary` pod/node. Another one is a replica service named `<postgres-name>-replicas` and points to Postgres `replica` pods/nodes.
419419

420-
These `master` and `replica` services can be customized using [spec.serviceTemplate](#spec.servicetemplate) and [spec.replicaServiceTemplate](#specreplicaservicetemplate) respectively.
420+
These `master` and `replica` services can be customized using [spec.serviceTemplates](#spec.servicetemplate) and [spec.replicaServiceTemplate](#specreplicaservicetemplate) respectively.
421421

422-
You can provide template for the `master` service using `spec.serviceTemplate`. This will allow you to set the type and other properties of the service. If `spec.serviceTemplate` is not provided, KubeDB will create a `master` service of type `ClusterIP` with minimal settings.
422+
You can provide template for the `master` service using `spec.serviceTemplates`. This will allow you to set the type and other properties of the service. If `spec.serviceTemplates` is not provided, KubeDB will create a `master` service of type `ClusterIP` with minimal settings.
423423

424-
KubeDB allows following fields to set in `spec.serviceTemplate`:
424+
KubeDB allows following fields to set in `spec.serviceTemplates`:
425425

426426
- metadata:
427427
- annotations
@@ -442,7 +442,7 @@ See [here](https://github.com/kmodules/offshoot-api/blob/kubernetes-1.16.3/api/v
442442

443443
You can provide template for the `replica` service using `spec.replicaServiceTemplate`. If `spec.replicaServiceTemplate` is not provided, KubeDB will create a `replica` service of type `ClusterIP` with minimal settings.
444444

445-
The fileds of `spec.replicaServiceTemplate` is similar to `spec.serviceTemplate`, that is:
445+
The fileds of `spec.replicaServiceTemplate` is similar to `spec.serviceTemplates`, that is:
446446

447447
- metadata:
448448
- annotations

docs/guides/postgres/concepts/postgres.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -372,15 +372,15 @@ If a service account name is given, and there's an existing service account by t
372372

373373
`spec.podTemplate.spec.nodeSelector` is an optional field that specifies a map of key-value pairs. For the pod to be eligible to run on a node, the node must have each of the indicated key-value pairs as labels (it can have additional labels as well). To learn more, see [here](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector) .
374374

375-
### spec.serviceTemplate
375+
### spec.serviceTemplates
376376

377377
KubeDB creates two different services for each Postgres instance. One of them is a master service named `<postgres-name>` and points to the Postgres `Primary` pod/node. Another one is a replica service named `<postgres-name>-replicas` and points to Postgres `replica` pods/nodes.
378378

379-
These `master` and `replica` services can be customized using [spec.serviceTemplate](#spec.servicetemplate) and [spec.replicaServiceTemplate](#specreplicaservicetemplate) respectively.
379+
These `master` and `replica` services can be customized using [spec.serviceTemplates](#spec.servicetemplate) and [spec.replicaServiceTemplate](#specreplicaservicetemplate) respectively.
380380

381-
You can provide template for the `master` service using `spec.serviceTemplate`. This will allow you to set the type and other properties of the service. If `spec.serviceTemplate` is not provided, KubeDB will create a `master` service of type `ClusterIP` with minimal settings.
381+
You can provide template for the `master` service using `spec.serviceTemplates`. This will allow you to set the type and other properties of the service. If `spec.serviceTemplates` is not provided, KubeDB will create a `master` service of type `ClusterIP` with minimal settings.
382382

383-
KubeDB allows following fields to set in `spec.serviceTemplate`:
383+
KubeDB allows following fields to set in `spec.serviceTemplates`:
384384

385385
- metadata:
386386
- annotations
@@ -401,7 +401,7 @@ See [here](https://github.com/kmodules/offshoot-api/blob/kubernetes-1.16.3/api/v
401401

402402
You can provide template for the `replica` service using `spec.replicaServiceTemplate`. If `spec.replicaServiceTemplate` is not provided, KubeDB will create a `replica` service of type `ClusterIP` with minimal settings.
403403

404-
The fileds of `spec.replicaServiceTemplate` is similar to `spec.serviceTemplate`, that is:
404+
The fileds of `spec.replicaServiceTemplate` is similar to `spec.serviceTemplates`, that is:
405405

406406
- metadata:
407407
- annotations

docs/guides/proxysql/concepts/proxysql/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -386,11 +386,11 @@ If you don't specify `spec.deletionPolicy` KubeDB uses `Halt` termination policy
386386

387387
> For more details you can visit [here](https://appscode.com/blog/post/deletion-policy/)
388388

389-
### .spec.serviceTemplate
389+
### .spec.serviceTemplates
390390

391-
You can also provide a template for the services created by KubeDB operator for the ProxySQL through `.spec.serviceTemplate`. This will allow you to set the type and other properties of the services.
391+
You can also provide a template for the services created by KubeDB operator for the ProxySQL through `.spec.serviceTemplates`. This will allow you to set the type and other properties of the services.
392392

393-
KubeDB allows following fields to set in `.spec.serviceTemplate`:
393+
KubeDB allows following fields to set in `.spec.serviceTemplates`:
394394

395395
- metadata:
396396
- annotations

0 commit comments

Comments
 (0)