Skip to content

Commit

Permalink
Fix overview
Browse files Browse the repository at this point in the history
Signed-off-by: Neaj Morshad <[email protected]>
  • Loading branch information
Neaj-Morshad-101 committed Oct 18, 2024
1 parent ca9fc20 commit 068c7c4
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/guides/mssqlserver/configuration/using-config-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ SQL Server allows configuring database via configuration file. The default confi
At first, you have to create a config file named `mssql.conf` with your desired configuration. Then you have to create a [secret](https://kubernetes.io/docs/concepts/configuration/secret/) using this file. Then specify this secret name in `spec.configSecret.name` section while creating MSSQLServer CR.

KubeDB will create a secret named `{mssqlserver-name}-config` with configuration file contents as the value of the key `mssql.conf` and mount this secret into `/var/opt/mssql/` directory of the database pod. the secret named `{mssqlserver-name}-config` will contain your desired configurations with some default configurations.
KubeDB will create a secret named `{mssqlserver-name}-config` with configuration file contents as the value of the key `mssql.conf` and mount this secret into `/var/opt/mssql/` directory of the database pod. The secret named `{mssqlserver-name}-config` will contain your desired configurations with some default configurations.

In this tutorial, we will configure sql server via a custom config file.

Expand Down
4 changes: 1 addition & 3 deletions docs/guides/mssqlserver/tls/ag_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,4 @@ clusterissuer.cert-manager.io "mssqlserver-ca-issuer" deleted
## Next Steps

- Detail concepts of [MSSQLServer object](/docs/guides/mssqlserver/concepts/mssqlserver.md).
- [Backup and Restore](/docs/guides/mssqlserver/backup/kubestash/overview/index.md) MSSQLServer databases using KubeStash. .
- Monitor your MSSQLServer database with KubeDB using [out-of-the-box Prometheus operator](/docs/guides/mssqlserver/monitoring/using-prometheus-operator.md).
- Monitor your MSSQLServer database with KubeDB using [out-of-the-box builtin-Prometheus](/docs/guides/mssqlserver/monitoring/using-builtin-prometheus.md).
- [Backup and Restore](/docs/guides/mssqlserver/backup/overview/index.md) MSSQLServer databases using KubeStash. .
14 changes: 6 additions & 8 deletions docs/guides/mssqlserver/tls/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,9 @@ Read about the fields in details from [MSSQLServer Concepts](/docs/guides/mssqls
`KubeDB` uses the `Issuer` or `ClusterIssuer` referenced in the `tls.issuerRef` field, and the certificate specs provided in `tls.certificate` to generate certificate secrets using `Issuer/ClusterIssuers` specification. These certificates secrets including `ca.crt`, `server.crt` and `server.key` etc. are used to configure `MSSQLServer` server, exporter etc. respectively.


# TODO......................

## How TLS/SSL configures in MSSQLServer

The following figure shows how `KubeDB` enterprise used to configure TLS/SSL in MSSQLServer. Open the image in a new tab to see the enlarged version.
The following figure shows how `KubeDB` used to configure TLS/SSL in MSSQLServer. Open the image in a new tab to see the enlarged version.

<figure align="center">
<img alt="Deploy MSSQLServer with TLS/SSL" src="/docs/images/day-2-operation/mssqlserver/ms-tls.svg">
Expand All @@ -50,17 +48,17 @@ The following figure shows how `KubeDB` enterprise used to configure TLS/SSL in

Deploying MSSQLServer with TLS/SSL configuration process consists of the following steps:

1. At first, a user creates a `Issuer/ClusterIssuer` cr.
1. At first, a user creates a `Issuer/ClusterIssuer` CR.

2. Then the user creates a `MSSQLServer` cr which refers to the `Issuer/ClusterIssuer` cr that the user created in the previous step.
2. Then the user creates a `MSSQLServer` CR which refers to the `Issuer/ClusterIssuer` CR that the user created in the previous step.

3. `KubeDB` Provisioner operator watches for the `MSSQLServer` cr.
3. `KubeDB` Provisioner operator watches for the `MSSQLServer` CR.

4. When it finds one, it creates `Secret`, `Service`, etc. for the `MSSQLServer` database.
4. When it finds one, it creates `Secret`, `Service`, etc. for the `MSSQLServer`.

5. `KubeDB` Ops-manager operator watches for `MSSQLServer`(5c), `Issuer/ClusterIssuer`(5b), `Secret` and `Service`(5a).

6. When it finds all the resources(`MSSQLServer`, `Issuer/ClusterIssuer`, `Secret`, `Service`), it creates `Certificates` by using `tls.issuerRef` and `tls.certificates` field specification from `MSSQLServer` cr.
6. When it finds all the resources(`MSSQLServer`, `Issuer/ClusterIssuer`, `Secret`, `Service`), it creates `Certificates` by using `tls.issuerRef` and `tls.certificates` field specification from `MSSQLServer` CR.

7. `cert-manager` watches for certificates.

Expand Down
4 changes: 1 addition & 3 deletions docs/guides/mssqlserver/tls/standalone.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,4 @@ issuer.cert-manager.io "mssqlserver-ca-issuer" deleted
## Next Steps

- Detail concepts of [MSSQLServer object](/docs/guides/mssqlserver/concepts/mssqlserver.md).
- [Backup and Restore](/docs/guides/mssqlserver/backup/kubestash/overview/index.md) MSSQLServer databases using KubeStash. .
- Monitor your MSSQLServer database with KubeDB using [out-of-the-box Prometheus operator](/docs/guides/mssqlserver/monitoring/using-prometheus-operator.md).
- Monitor your MSSQLServer database with KubeDB using [out-of-the-box builtin-Prometheus](/docs/guides/mssqlserver/monitoring/using-builtin-prometheus.md).
- [Backup and Restore](/docs/guides/mssqlserver/backup/overview/index.md) MSSQLServer databases using KubeStash. .
4 changes: 4 additions & 0 deletions docs/images/day-2-operation/mssqlserver/ms-tls.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 068c7c4

Please sign in to comment.