Cadoles/bouncer
Cadoles
/
bouncer
10
0
Fork 0
Code Issues 6 Pull Requests Projects Releases 3 Wiki Activity

doc: update create custom layer tutorial
Cadoles/bouncer/pipeline/head This commit looks good Details

This commit is contained in:
wpetit 2024-06-25 11:32:54 +02:00
parent ea68724635
commit 9d902a7494
1 changed files with 9 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/fr/tutorials/create-custom-layer.md
View File

@ -10,13 +10,13 @@ Avoir un environnement de développement local fonctionnel. Voir tutoriel ["Dém
### Préparer la structure de base du nouveau layer ### Préparer la structure de base du nouveau layer
Une implémetation d'un layer se compose majoritairement de 3 éléments: Une implémentation d'un layer se compose majoritairement de 3 éléments:
- Une structure qui implémente une ou plusieurs interfaces (`director.MiddlewareLayer`, `director.RequestTransformerLayer` et/ou `director.ResponseTransformerLayer`); - Une structure qui implémente une ou plusieurs interfaces (`director.MiddlewareLayer`, `director.RequestTransformerLayer` et/ou `director.ResponseTransformerLayer`);
- Un schéma au format [JSON Schema](http://json-schema.org/) qui permettra de valider les "options" de notre layer; - Un schéma au format [JSON Schema](http://json-schema.org/) qui permettra de valider les "options" de notre layer;
- Un fichier d'amorçage qui permettra à Bouncer de référencer notre nouveau layer. - Un fichier d'amorçage qui permettra à Bouncer de référencer notre nouveau layer.
1. Créer le répertoire du `package` Go qui contiendra le code de votre layer. Celui ci s'appelera `basicauth`: 1. Créer le répertoire du `package` Go qui contiendra le code de votre layer. Celui ci s’appellera `basicauth`:
``` ```
mkdir -p internal/proxy/director/layer/basicauth mkdir -p internal/proxy/director/layer/basicauth
@ -133,26 +133,22 @@ Une implémetation d'un layer se compose majoritairement de 3 éléments:
## Tester l'intégration de notre nouveau layer ## Tester l'intégration de notre nouveau layer
À ce stade, notre nouveau layer est normalement référencé et donc "utilisable" dans Bouncer (si on omet le fait qu'il déclenchera une `panic()`). À ce stade, notre nouveau layer est normalement référencé et donc "utilisable" dans Bouncer (si on omet le fait qu'il déclenchera un `panic()`).
1. Vérifier que notre layer est bien référencé en exécutant la commande: 1. Vérifier que notre layer est bien référencé en exécutant la commande:
``` ```
./bin/bouncer admin layer create --help ./bin/bouncer admin definition layer query --with-type basicauth
``` ```
La sortie devrait ressembler à: La sortie devrait ressembler à:
``` ```
NAME: +-----------+-----------------------------------+
bouncer admin layer create - Create layer | TYPE | OPTIONS |
+-----------+-----------------------------------+
USAGE: | basicauth | {"type":"object","properties":... |
bouncer admin layer create [command options] [arguments...] +-----------+-----------------------------------+
OPTIONS:
--layer-type LAYER_TYPE Set LAYER_TYPE as layer's type (available: [basicauth queue])
[...]
``` ```
Comme vous devriez le voir nous pouvons désormais créer des layers de type `basicauth`. Comme vous devriez le voir nous pouvons désormais créer des layers de type `basicauth`.