Skip to content

Commit a295882

Browse files
author
Bastien V
committed
update or first part doc Enterprise DB
- applied OVH guidelines - removed useless guide
1 parent fbeb57d commit a295882

File tree

12 files changed

+284
-132
lines changed

12 files changed

+284
-132
lines changed

Diff for: docs-guideline/markdown-custom.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111
> [!alert]
1212
>
1313
> this is an alert!
14-
>
14+
>
1515
```
1616

1717
```html
18-
<!-- generated html -->
18+
<!-- generated html -->
1919

2020
<div class="callout alert">
2121
<p>this is an alert!</p>
@@ -34,7 +34,7 @@
3434
> [!primary]
3535
>
3636
> this is a primary notice!
37-
>
37+
>
3838
```
3939

4040
![alert notice](images/notice-primary.png)
@@ -47,7 +47,7 @@
4747
> [!warning]
4848
>
4949
> this is a warning!
50-
>
50+
>
5151
```
5252

5353
![alert notice](images/notice-warning.png)
@@ -60,7 +60,7 @@
6060
> [!info]
6161
>
6262
> this is a simple notice!
63-
>
63+
>
6464
```
6565

6666
![alert notice](images/notice-simple.png)
@@ -76,7 +76,7 @@
7676
> - ![caption of image 1](images/01.jpg)
7777
> - ![caption of image 2](images/02.jpg)
7878
> - ![caption of image 3](images/03.jpg)
79-
>
79+
>
8080
```
8181

8282
```html

Diff for: pages/cloud/entreprise-cloud-databases/add-delete-cluster-node/guide.fr-fr.md

+27-9
Original file line numberDiff line numberDiff line change
@@ -5,38 +5,50 @@ excerpt: 'Apprenez comment ajouter ou supprimer un nœud à votre cluster'
55
section: 'Démarrer avec votre cluster PostgreSQL'
66
---
77

8-
## Architecture d'un cluster
8+
**Dernière mise à jour le 20/12/2019**
99

10-
Cette offre se compose par défaut de 3 nœuds, assurant le bon fonctionnement de la haute disponibilité du service. Il s'agit du minimum nécessaire au fonctionnement du cluster.
10+
## Objectif
11+
Les offres Enterprise Cloud Databases proposent des instances de bases de données composées de plusieurs nœuds physiques.
12+
Composé au minimum de 3 nœuds, chaque cluster sait assurer une mise à l'échelle horizontale, pour gagner en performance et en résilience.
13+
Ce guide vous explique comment ajouter et supprimer des nœuds supplémentaires sur votre cluster.
1114

12-
## Croissance horizontale et résilience
1315

14-
Lorsque la charge de votre applicatif augmente, l'offre d'OVHcloud vous permet d'y faire face en vous donnant la possibilité d'ajouter (et de réduire dans un second temps) des nœuds en lecture seule à votre cluster.
16+
## Pré-requis
17+
- Disposer d'un cluster Enterprise Cloud Databases.
18+
- Disposer d'un accès à l'espace client ou à l'API avec des droits suffisants (administrateur ou technique).
1519

16-
Ajoutez de la puissance de calcul à votre cluster en fonction de vos besoins.
20+
21+
## En pratique
22+
23+
### Étape 1 : comprendre les bénéfices d'une mise à l'échelle
24+
Lorsque la charge de votre applicatif augmente, votre base de données est souvent davantage sollicitée en lecture et en écriture. Plus d'informations à traiter, toujours aussi rapidement. Enterprise Cloud Databases vous permet de répartir ces requêtes sur plusieurs nœuds.
25+
26+
Chaque nœud supplémentaire vous permet d'augmenter votre capacité à accepter des requêtes en lecture, et améliore également la résilience de votre cluster.
27+
28+
Ajoutez ou suppirmez de la puissance de calcul à votre cluster en fonction de vos besoins.
1729

1830
> [!primary]
1931
>
2032
> Nous recommandons de garder un nombre impair de nœuds à l’intérieur de votre cluster afin de respecter le quorum lié à la gestion de la haute disponibilité.
2133
>
2234
23-
## Ajout d'un nœud
2435

36+
### Étape 2 : ajout d'un nœud
2537
Vous pouvez ajouter un maximum de 8 nœuds supplémentaires, pour un total de 10 nœuds de lecture seule (réplicas) au sein du cluster.
2638

27-
Utilisez votre espace client pour ajouter une ou plusieurs ressources additionnelles. Cliquez sur `Cluster Nodes`{.action} puis `Actions`{.action} et `Add replica`{.action}.
39+
Utilisez votre espace client pour ajouter une ou plusieurs ressources additionnelles. Cliquez sur `Nœuds du cluster`{.action} puis `Actions`{.action} et `Ajouter un réplica`{.action}.
2840

2941
Vous serez amenés à choisir le nombre de réplicas que vous souhaitez ajouter au travers d'une boîte de dialogue dédiée.
3042

3143
> [!primary]
3244
> Le nouveau nœud s'inscrit dans le quorum de haute disponibilité et peut ainsi devenir primaire (et donc porter les écritures) au cours de la vie du cluster.
3345
>
3446
35-
## Suppression d'un nœud
3647

48+
## Étape 3 : suppression d'un nœud
3749
Utilisez l'interface de votre espace client pour supprimer un nœud ajouté.
3850

39-
Consultez la page `Cluster Nodes`{.action} puis cliquez sur le bouton `...`{.action} puis `remove`{.action} pour supprimer une ressource.
51+
Consultez la page `Nœuds du cluster`{.action} puis cliquez sur le bouton `...`{.action} puis `supprimer`{.action} pour supprimer une ressource.
4052

4153
Vous serez amenés à choisir le nombre de réplicas que vous souhaitez supprimer au travers d'une boîte de dialogue dédiée.
4254

@@ -47,3 +59,9 @@ Vous serez amenés à choisir le nombre de réplicas que vous souhaitez supprime
4759
> [!primary]
4860
> Attention, la suppression d'un nœud peut entraîner une courte période d’indisponibilité si l'action provoque la promotion d'un nouveau nœud.
4961
>
62+
63+
## Aller plus loin
64+
65+
Apprenez à gérer votre cluster PostgreSQL en consultant la [documentation technique d'OVHcloud](../enterprise-cloud-databases/){.external} pour davantage d'informations sur le fonctionnement technique de votre offre managée.
66+
67+
Échangez avec notre communauté d'utilisateurs sur <https://community.ovh.com>

Diff for: pages/cloud/entreprise-cloud-databases/backup-principles/guide.en-gb.md

-8
This file was deleted.

Diff for: pages/cloud/entreprise-cloud-databases/backup-principles/guide.fr-fr.md

-34
This file was deleted.

Diff for: pages/cloud/entreprise-cloud-databases/configure-securitygroups/guide.fr-fr.md

+40-11
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,58 @@ excerpt: 'Protéger l''accès à votre cluster au travers de filtres d''accès'
55
section: 'Démarrer avec votre cluster PostgreSQL'
66
---
77

8-
## Fonctionnement des groupes de sécurité
9-
Votre cluster est un service exposé sur le réseau public. Pour des questions de sécurité, OVH vous impose la création de filtres pour vous laisser accéder à votre cluster.
8+
**Dernière mise à jour le 20/12/2019**
109

11-
Ces filtres sont réalisés au travers des groupes de sécurité. Par défaut, tout le trafic entrant est bloqué sur votre cluster. Seules les IPs publiques contenues dans ces groupes seront autorisées à accéder au cluster.
10+
## Objectif
11+
Les offres Enterprise Cloud Databases sont compatibles avec n'importe quel service joignable par le réseau public (Internet), tel que l'ensemble des produits cloud OVHcloud, mais également des fournisseurs de cloud tierces, ou encore votre propre architecture.
1212

13-
Les filtres sont appliqués sur les instances restaurées et le répartiteur de charge, une brique d'infrastructure de votre cluster situé en amont de vos nœuds. Consultez [la documentation OVH](https://docs.ovh.com/fr/load-balancer/){.external} pour plus d'informations sur les répartiteurs de charges.
13+
Afin de sécuriser les accès, il est nécessaire d'autoriser des IPs à ce connecter sur votre cluster.
14+
Ce guide vous explique comment gérer vos groupes et règles de sécurité.
1415

1516

16-
## Règles de sécurité
17-
Utilisez votre espace client pour interagir avec vos groupes de sécurité.
17+
## Pré-requis
18+
- Disposer d'un cluster Enterprise Cloud Databases.
19+
- Disposer d'un accès à l'espace client ou à l'API avec des droits suffisants (administrateur ou technique).
20+
- Disposer d'une IPv4 ou plage IPv4 à autoriser.
1821

19-
Les groupes de sécurité sont présentés sous forme de listes depuis la rubrique `Settings`{.action}.
2022

21-
Utilisez ces groupes pour ajouter / supprimer une ou plusieurs adresses IPs.
23+
## En pratique
24+
25+
### Étape 1 : comprendre les mécansimes de sécurité
26+
Votre cluster est un service exposé sur le réseau public, n'autorisant par défaut aucune connexion extérieure.
27+
Pour des questions de sécurité, OVHcloud vous impose la création de groupes et règles de sécurité pour vous connecter à votre cluster.
28+
Cette liste blanche vient en compléments d'autre mécanisme, tels que des flux sécurisés via TLS ou du chiffrement de vos données.
29+
30+
31+
### Étape 2 : crée ou supprimer un groupe de sécurité
32+
Un groupe de sécurité peut contenir de multiples règles de sécurité. Ils vous permettent de ranger et trier vos règles de sécurité plus facilement.
33+
Pour créer un groupe, rendez-vous dans votre espace client, puis cliquez sur `Paramètres`{.action} puis `Groupes de sécurité`{.action} et enfin `Créer un groupe`{.action}.
34+
Un nom pour votre groupe vous sera demandé.
35+
36+
Une fois créé, vous verrez apparaître votre groupe de sécurité sur cette même page, dans laquel il est possible de modifier le nom de votre gorupe ou le supprimer
37+
38+
39+
### Étape 3: créer ou supprimer une règle de sécurité
40+
Une fois votre groupe de sécurité créé, cliquez sur `...`{.action} puis `Ajouter une règle`{.action}.
41+
Renseignez la règle de sécurité désirée puis validez.
42+
2243

2344
> [!primary]
24-
> Les adresses IP que vous renseignez doivent respecter certaintes règles :
45+
> Les adresses IP que vous renseignez doivent respecter certaines règles :
2546
>
2647
> - être une IP valide
27-
> - ne pas doit pas commencer par 0.0.0.0
28-
> - ne pas être une IP privée ("10.0.0.0/8", "172.16.0.0/12" ou "192.168.0.0/16")
48+
> - ne pas commencer par 0.0.0.0
49+
> - ne pas être une IP privée ("10.0.0.0/8", "172.16.0.0/12" ou "192.168.0.0/16")
2950
>
3051
52+
3153
> [!primary]
3254
> Attention : vous devez conserver un groupe de sécurité actif contenant au moins une adresse IP valide pour pouvoir accéder à votre cluster.
3355
>
56+
57+
58+
## Aller plus loin
59+
60+
Apprenez à gérer votre cluster PostgreSQL en consultant la [documentation technique d'OVHcloud](../enterprise-cloud-databases/){.external} pour davantage d'informations sur le fonctionnement technique de votre offre managée.
61+
62+

Diff for: pages/cloud/entreprise-cloud-databases/configure-superuser/guide.fr-fr.md

+34-3
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,31 @@ section: 'Démarrer avec votre cluster PostgreSQL'
66
order: 3
77
---
88

9-
## Configurer le mot de passe de votre utilisateur adminstrateur
9+
**Dernière mise à jour le 20/12/2019**
1010

11-
OVH vous fournit un compte administrateur pour votre instance de base de données. Cet utilisateur **postgres** peut réaliser toutes les opérations techniques de type "administration".
11+
## Objectif
12+
13+
Chaque cluster Enterprise Cloud Databases est configuré nativement avec un utilisateur administrateur.
14+
Ce guide va vous présenter les étapes nécessaire à son utilisation.
15+
16+
17+
## Pré-requis
18+
- Disposer d'un cluster Enterprise Cloud Databases.
19+
- Disposer d'un accès à l'espace client ou à l'API avec des droits suffisants (administrateur ou technique).
20+
21+
22+
## En pratique
23+
24+
### Étape 1 : comprendre les rôles superuser
25+
26+
OVH vous fournit un compte administrateur pour votre instance de base de données. Cet utilisateur **postgres** peut réaliser toutes les opérations techniques de type "administration". il dispose des droits superuser.
1227

1328
Reportez-vous à la [documentation officielle de PostgreSQL](https://www.postgresql.org/docs/current/role-attributes.html){.external} pour connaître ces privilèges.
1429

15-
Ce mot de passe est modifiable à tout instant. Pour ce faire, rendez-vous sur votre espace client dans l'onglet `Overview > Informations`{.action} et cliquez sur le bouton `...`{.action} puis `Update Password`{.action}.
30+
31+
### Étape 2 : configuration via espace client
32+
33+
Le mot de passe de l'utilisateur administrateur **postgres** est modifiable à tout instant. Pour ce faire, rendez-vous sur votre espace client dans l'onglet `Accueil > Informations`{.action} et au niveau des identifiants cliquez sur le bouton `...`{.action} puis `Mettre à jour le mot de passe`{.action}.
1634

1735
> [!primary]
1836
> Pour des raisons de sécurité, le mot de passe doit respecter certaines règles de complexité :
@@ -22,3 +40,16 @@ Ce mot de passe est modifiable à tout instant. Pour ce faire, rendez-vous sur v
2240
> - doit contenir au moins deux chiffres
2341
> - faire entre 12 et 32 caractères
2442
>
43+
44+
45+
### Étape 2 bis : configuration via API
46+
47+
La route API suivante vous permet de mettre à jour votre mot de passe administrateur.
48+
Veillez à respecter les règles de complexité définies à l'étape 2.
49+
50+
51+
> [!api]
52+
>
53+
> @api {POST} /cloudDB/enterprise/cluster/{clusterId}/user
54+
>
55+
```

Diff for: pages/cloud/entreprise-cloud-databases/create-database-user/guide.fr-fr.md

+58-24
Original file line numberDiff line numberDiff line change
@@ -5,52 +5,86 @@ excerpt: 'Comment créer vos bases et utilisateurs à l''intérieur de votre clu
55
section: 'Démarrer avec votre cluster PostgreSQL'
66
---
77

8-
## Pour commencer
8+
**Dernière mise à jour le 26/12/2019**
99

10-
Cette documentation fournit les étapes à suivre afin de créer votre première base de données et votre premier utilisateur.
10+
## Objectif
1111

12-
*Note : référez-vous à la [documentation technique de PostgreSQL](https://www.postgresql.org/docs/){.external} pour de plus amples informations.*
12+
Ce guide vous explique comment créer vos premières bases de données et utilisateurs dans votre cluster Enteprise Cloud Databases pour PostgreSQL.
13+
Pour une documentation exhaustive, référez-vous à la [documentation technique officielle de PostgreSQL](https://www.postgresql.org/docs/){.external}.
1314

1415

15-
## Interagir avec votre cluster en ligne de commandes
16+
## Pré-requis
17+
- Disposer d'un cluster Enterprise Cloud Databases pour PostgreSQL.
18+
- Avoir configuré le mot de passe de votre utilisateur administrateur.
19+
- Avoir configuré au moins une règle de sécurité.
1620

17-
- **Étape 1 - Connectez-vous à votre cluster avec votre super-utilisateur**
1821

19-
L'espace client vous affichera les informations utiles depuis la section `Overview`{.action} puis `Connection Information`{.action}
22+
## Rappel
23+
24+
Vous possédez le compte administrateur PostgreSQL **postgres** qui à la possibilité de réaliser tous types d'opérations sur la base de données.
25+
26+
> [!primary]
27+
> Il est impératif de ne pas modifier les configurations techniques mises en place par OVHcloud au risque de dégrader ou d’empêcher le bon fonctionnement de votre cluster.
28+
>
29+
30+
31+
## En pratique
32+
33+
### Étape 1 : Installation d'un client PostgreSQL
34+
35+
Sur un système d'exploitation Unix/Linux, il convient d'installer le paquet postgresql-client pour se connecter en ligne de commande. Réferrez-vous à la documentation officelle de votre système d'exploitation.
36+
37+
Sur Microsoft Windows, il existe une multitude de solutions en lignes de commande ou interfaces visuelles (GUI). Elles sont référencées dans la [documentation wiki de PostgreSQL](https://wiki.postgresql.org/wiki/PostgreSQL_Clients){.external}. Choisissez celui qui vous convient le mieux.
38+
39+
La suite des étapes détaille une procédure de connexion par lignes de commande.
40+
2041

21-
Exemples de chaînes de connexions :
42+
### Étape 2 : Connexion au cluster
43+
44+
Dans votre espace client OVHcloud, retrouvez les informations utiles depuis la section `Accueil`{.action} puis `Informations de connexion`{.action}.
45+
46+
Enterprise Cloud Databases vous propose des paramètres de connexion en lecture seule, et en lecture-écriture.
47+
Pour créer des bases de données et utilisateurs, il est nécessaire d'utiliser les paramètres de connexion en lecture-écriture.
48+
49+
Exemples d'informations de connexion en lignes de commandes :
2250

2351
read-write
24-
postgresql://postgres:************@5f771a6d99ee4102980c2d.prm.clouddb.ovh.net:38697/postgres?sslmode-require
25-
psql -U postgres -h 5f771a6d99ee4102980c2d.prm.clouddb.ovh.net -p 38697 -W --set=sslmode=require
52+
psql -U postgres -h 123456d99ee4102980c2d.prm.clouddb.ovh.net -p 38697 -W --set=sslmode=require
2653

2754
read-only
28-
postgresql://postgres:************@5f771a6d99ee4102980c2d.prm.clouddb.ovh.net:6713/postgres?sslmode=require
29-
psql -U postgres -h 5f771a6d99ee4102980c2d.prm.clouddb.ovh.net -p 6713 -W --set=sslmode=require
55+
psql -U postgres -h 1234566d99ee4102980c2d.prm.clouddb.ovh.net -p 6713 -W --set=sslmode=require
3056

3157

32-
- **Étape 2 - Créez votre utilisateur**
58+
Copiez les informations de connexion dans votre interface de lignes de commande.
59+
Un mot de passe vous sera demandé, celui de votre administrateur `postgres` préalablement configuré.
3360

34-
Depuis le shell PostgreSQL
3561

36-
postgres=# CREATE ROLE username NOINHERIT LOGIN PASSWORD 'password';
62+
### Étape 3 : Création d'utilisateurs
3763

64+
Une fois connecté à votre cluster, vous avez la possibilité de réaliser une multitude d'opérations.
65+
[La documentation officielle de PostgreSQL](https://www.postgresql.org/docs/manuals/){.external} recense et détaille ces cas de figures, par version.
3866

39-
- **Étape 3 - Créez votre base de données**
67+
PostgreSQL repose sur un sytème de rôles et d'utilisateurs. Un rôle peut contenir plusieurs utilisateurs et ses capacités peuvent être définies précisément : accès à une base spécifique, en lecture seule ou lecture-écriture, pendant une période limitée, capacité à créer des tables, des utilisateurs, ...
4068

41-
Depuis le shell PostgreSQL
4269

43-
postgres=# CREATE DATABASE name OWNER username;
70+
En version 12, voici un exemple basique de ligne de commande créant l'utilisateur `martin` avec le mot de passe `password`.
4471

45-
- **Étape 4 - Accédez à votre base de données avec votre nouvel utilisateur dédié**
4672

47-
psql -U username -h fqdn -p port -W --set=sslmode=require databasename
73+
postgres=# CREATE ROLE martin NOINHERIT LOGIN PASSWORD 'password';
4874

4975

50-
## Rappel
76+
### Étape 4 : Création de bases de données
5177

52-
Vous possédez le compte administrateur PostgreSQL **postgres** qui à la possibilité de réaliser tous types d'opérations sur la base de données.
78+
De la même manière, voici un exemple basique pour la création de la base de données `mydatabase`, avec l'utilisateur `martin` qui en sera le propriétaire.
5379

54-
> [!primary]
55-
> Il est impératif de ne pas modifier les configurations techniques mises en place par OVHcloud au risque de dégrader ou d’empêcher le bon fonctionnement de votre cluster.
56-
>
80+
postgres=# CREATE DATABASE mydatabase OWNER username;
81+
82+
83+
Votre utilisateur `martin` pourra ainsi s'y connecter de la manière suivante :
84+
85+
psql -U martin -h fqdn -p port -W --set=sslmode=require mydatabase
86+
87+
88+
## Aller plus loin
89+
90+
Apprenez à gérer votre cluster PostgreSQL en consultant la [documentation technique d'OVHcloud](../enterprise-cloud-databases/){.external} pour davantage d'informations sur le fonctionnement technique de votre offre managée.

0 commit comments

Comments
 (0)