Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/guides/ignite/concepts/ignite.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,11 +183,11 @@ If a service account name is given, and there's an existing service account by t

`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/).

### spec.serviceTemplate
### spec.serviceTemplates

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.
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.

KubeDB allows following fields to set in `spec.serviceTemplate`:
KubeDB allows following fields to set in `spec.serviceTemplates`:

- `alias` represents the identifier of the service. It has the following possible value:
- `primary` is used for the primary service identification.
Expand Down
20 changes: 17 additions & 3 deletions docs/guides/mariadb/concepts/mariadb/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -330,11 +330,11 @@ for: "./mariadb.yaml": admission webhook "mariadb.validators.kubedb.com" denied

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.

### spec.serviceTemplate
### spec.serviceTemplates

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.
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.

KubeDB allows following fields to set in `spec.serviceTemplate`:
KubeDB allows following fields to set in `spec.serviceTemplates`:

- metadata:
- annotations
Expand All @@ -349,6 +349,20 @@ KubeDB allows following fields to set in `spec.serviceTemplate`:
- healthCheckNodePort
- sessionAffinityConfig

```bash
spec:
version: "10.6.16"
serviceTemplates:
- alias: primary
metadata:
annotations:
kubedb.com/test-annotation: "test"
spec:
type: LoadBalancer
ports:
- port: 3306
```

See [here](https://github.com/kmodules/offshoot-api/blob/kubernetes-1.16.3/api/v1/types.go#L163) to understand these fields in detail.

### spec.halted
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/memcached/concepts/memcached.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,11 +210,11 @@ If a service account name is given, and there's an existing service account by t

`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/).

### spec.serviceTemplate
### spec.serviceTemplates

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.
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.

KubeDB allows following fields to set in `spec.serviceTemplate`:
KubeDB allows following fields to set in `spec.serviceTemplates`:

- `alias` represents the identifier of the service. It has the following possible value:
- `primary` is used for the primary service identification.
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/mssqlserver/concepts/mssqlserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -487,13 +487,13 @@ The following fields are configurable in the `spec.tls` section:
- `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.


### spec.serviceTemplate
### spec.serviceTemplates

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.

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

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.
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.

KubeDB allows following fields to set in `spec.serviceTemplates`:
- `alias` represents the identifier of the service. It has the following possible value:
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/mysql/concepts/database/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -387,11 +387,11 @@ for: "./mysql.yaml": admission webhook "mysql.validators.kubedb.com" denied the

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.

### spec.serviceTemplate
### spec.serviceTemplates

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.
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.

KubeDB allows following fields to set in `spec.serviceTemplate`:
KubeDB allows following fields to set in `spec.serviceTemplates`:

- metadata:
- annotations
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/percona-xtradb/concepts/perconaxtradb/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -319,11 +319,11 @@ for: "./perconaxtradb.yaml": admission webhook "perconaxtradb.validators.kubedb.

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.

### spec.serviceTemplate
### spec.serviceTemplates

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.
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.

KubeDB allows following fields to set in `spec.serviceTemplate`:
KubeDB allows following fields to set in `spec.serviceTemplates`:

- metadata:
- annotations
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/pgbouncer/concepts/pgbouncer.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,13 +225,13 @@ At least one of the following was changed:

`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) .

### spec.serviceTemplate
### spec.serviceTemplates

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

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.
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.

KubeDB allows the following fields to set in `spec.serviceTemplate`:
KubeDB allows the following fields to set in `spec.serviceTemplates`:

- metadata:
- annotations
Expand Down
10 changes: 5 additions & 5 deletions docs/guides/postgres/concepts/postgres-gitops.md
Original file line number Diff line number Diff line change
Expand Up @@ -413,15 +413,15 @@ If a service account name is given, and there's an existing service account by t
> Updating `postgres`/`pg-coordinator` containers resources will create a [`VerticalScaling`](/docs/guides/postgres/scaling/vertical-scaling/overview/index.md) OpsRequest by GitOps operator.


### spec.serviceTemplate
### spec.serviceTemplates

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.

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

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.
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.

KubeDB allows following fields to set in `spec.serviceTemplate`:
KubeDB allows following fields to set in `spec.serviceTemplates`:

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

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.

The fileds of `spec.replicaServiceTemplate` is similar to `spec.serviceTemplate`, that is:
The fileds of `spec.replicaServiceTemplate` is similar to `spec.serviceTemplates`, that is:

- metadata:
- annotations
Expand Down
10 changes: 5 additions & 5 deletions docs/guides/postgres/concepts/postgres.md
Original file line number Diff line number Diff line change
Expand Up @@ -372,15 +372,15 @@ If a service account name is given, and there's an existing service account by t

`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) .

### spec.serviceTemplate
### spec.serviceTemplates

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.

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

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.
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.

KubeDB allows following fields to set in `spec.serviceTemplate`:
KubeDB allows following fields to set in `spec.serviceTemplates`:

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

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.

The fileds of `spec.replicaServiceTemplate` is similar to `spec.serviceTemplate`, that is:
The fileds of `spec.replicaServiceTemplate` is similar to `spec.serviceTemplates`, that is:

- metadata:
- annotations
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/proxysql/concepts/proxysql/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -386,11 +386,11 @@ If you don't specify `spec.deletionPolicy` KubeDB uses `Halt` termination policy

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

### .spec.serviceTemplate
### .spec.serviceTemplates

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.
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.

KubeDB allows following fields to set in `.spec.serviceTemplate`:
KubeDB allows following fields to set in `.spec.serviceTemplates`:

- metadata:
- annotations
Expand Down
Loading