Skip to content

Commit 8f4fe4e

Browse files
author
Thomas Desplaces
committed
Change README from FR to EN
1 parent 4359b1e commit 8f4fe4e

File tree

3 files changed

+59
-59
lines changed

3 files changed

+59
-59
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This is a code to deploy sharedflows which are used when your backend is secured
77
## Prerequisite
88

99
- A GCP Project with, for example, an App Engine.
10-
- A service Account with good rights to call your App Engine and it's JSON Key.
10+
- A service Account with good rights to call your App Engine and his JSON Key.
1111
- An Apigee account with an organization (free or paid).
1212
- [Maven](https://github.com/apigee/apigee-deploy-maven-plugin) or [apigeetools](https://github.com/apigee/apigeetool-node) install on your computer to deploy the sharedflow.
1313
- Maven install on local computer.

sharedflows/gcp-token-iap/README.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22

33
## Description
44

5-
Ce sharedflow va permettre de demander un jeton OAuth à Google en fonction du service account qui lui ai passé en paramètre.
6-
Une fois le token récupéré alors on le met en cache durant la durée définit dans le fichier de configuration _caches.json_ (peut être différent pour chaque environnement. Dans nos exemples cette valeur est de 10 seconde en dev, 60 secondes en test et 3500 secondes en prd).
5+
This sharedflow will make it possible to request an OAuth token from Google according to the service account that was passed to it as a parameter.
6+
Once the token has been retrieved, then it is cached for the duration defined in the configuration file _caches.json_ (may be different for each environment. In our examples this value is 10 seconds in dev, 60 seconds in test and 3500 seconds in prd).
77
[Documentation Google](https://developers.google.com/identity/protocols/oauth2/service-account)
88

99
## Pré-requis
1010
Lors de l'utilisation de ce sharedflow dans un proxy il faut d'abord prévoir :
1111

12-
- Un sevice account qui a les droit d'appeler une API sur GCP via un IAP.
13-
- Le JSON de ce service account.
14-
- Créer une entrée dans le KVM chiffré *gcp-service-account-credentials* avec en clé le nom du projet et en valeur le contenu du JSON du service account.
15-
- Créer dans le proxy une variable nommée *private.credentialsjson* dont la valeur est le contenu du JSON du service account.
12+
- A service account that has the rights to call an API on GCP via IAP
13+
- The JSON of this service account
14+
- Create an entry in the encrypted KVM *gcp-service-account-credentials* with the project name as key and the service account JSON content as value
15+
- Create in the proxy a variable named *private.credentialsjson* whose value is the content of the JSON of the service account
1616

17-
## Fonctionnement
17+
## How to
1818

19-
Ce sharedflow exécute 7 policies d'affilées :
19+
This sharedflow executes 7 policies in a row :
2020
- lc.gcp-token
2121
- js.extract-credentials
2222
- gjwt.generate-JWT
@@ -27,42 +27,42 @@ Ce sharedflow exécute 7 policies d'affilées :
2727

2828
### lc.gcp-token
2929

30-
Cette policy vérifie si une valeur existe dans un cache dont le nom est composé :
31-
- nom de l'organisation
32-
- nom de l'environnement
33-
- nom du proxy
34-
- numéro de la révision
35-
- nom de la target
36-
Si une valeur est trouvée alors on instancie la valeur de la variable _google-credentials.id-token_ avec cette valeur.
37-
Cela permet d'éviter de demander un nouveau token si cette valeur est toujours présente (durée de cache encore valide).
30+
This policy checks if a value exists in a cache whose name is composed :
31+
- Organization name
32+
- Environment name
33+
- Proxy name
34+
- Revision number
35+
- Target name
36+
If a value is found then we instantiate the value of the _google-credentials.access-token_ variable with this value.
37+
This avoids asking for a new token if this value is still present (cache duration still valid).
3838

39-
** Les 4 étapes suivantes ne sont exécutées que si la variable _google-credentials.id-token_ n'est pas vide.**
39+
** The next 4 steps are only executed if the _google-credentials.access-token_ variable is not empty. **
4040

4141
### js.extract-credentials
4242

43-
Cette policy permet d'extraire chaque paire clé/valeur de la variable *private.credentialsjson* (qui contient le contenu du JSON du service account).
43+
This policy extracts each key/value pair from the *private.credentialsjson* variable (which contains the JSON content of the service account).
4444

4545
### gjwt.generate-JWT
4646

47-
Cette policy utilise les informations récupérées pour générer un jeton JWT. Ce jeton est inscrit dans la variable *output_jwt*.
47+
This policy uses the retrieved information to generate a JWT token. This token is written in the variable *output_jwt*.
4848

4949
### sc.gcp-oauth
5050

51-
Cette policy demande à GCP la création d'un jeton OAuth à partir du jeton JWT généré précédemment. Ce jeton est inscrit dans la variable *callout-token*.
51+
This policy asks GCP to create an OAuth token from the previously generated JWT token. This token is written in the variable *callout-token*.
5252

5353
### ev.extract-json
5454

55-
Cette policy extrait le jeton OAuth renvoyé précédemment et crée une variable *google-credentials.id-token*.
55+
This policy extracts the OAuth token returned earlier and creates a variable *google-credentials.access-token*.
5656

5757
### am.add-authorization
5858

59-
Cette policy crée une en-tête *Authorization* dont la valeur est *Bearer * + le contenu de la variable _google-credentials.id-token_.
59+
This policy creates an *Authorization* header whose value is *Bearer * + the content of the _google-credentials.access-token_ variable.
6060

6161
### pc.gcp-token
6262

63-
Cette policy met en cache la valeur de la variable _google-credentials.id-token_ dans un cache dont le nom est composé :
64-
- nom de l'organisation
65-
- nom de l'environnement
66-
- nom du proxy
67-
- numéro de la révision
68-
- nom de la target
63+
This policy caches the value of the _google-credentials.access-token_ variable in a cache whose name is composed :
64+
- Organization name
65+
- Environment name
66+
- Proxy name
67+
- Revision number
68+
- Target name

sharedflows/gcp-token-oauth/README.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22

33
## Description
44

5-
Ce sharedflow va permettre de demander un jeton OAuth à Google en fonction du service account qui lui ai passé en paramètre.
6-
Une fois le token récupéré alors on le met en cache durant la durée définit dans le fichier de configuration _caches.json_ (peut être différent pour chaque environnement. Dans nos exemples cette valeur est de 10 seconde en dev, 60 secondes en test et 3500 secondes en prd).
5+
This sharedflow will make it possible to request an OAuth token from Google according to the service account that was passed to it as a parameter.
6+
Once the token has been retrieved, then it is cached for the duration defined in the configuration file _caches.json_ (may be different for each environment. In our examples this value is 10 seconds in dev, 60 seconds in test and 3500 seconds in prd).
77
[Documentation Google](https://developers.google.com/identity/protocols/oauth2/service-account)
88

9-
## Pré-requis
10-
Lors de l'utilisation de ce sharedflow dans un proxy il faut d'abord prévoir :
9+
## Prerequisites
10+
When using this sharedflow in a proxy you must first provide :
1111

12-
- Un sevice account qui a les droit d'appeler une API sur GCP
13-
- Le JSON de ce service account
14-
- Créer une entrée dans le KVM chiffré *gcp-service-account-credentials* avec en clé le nom du projet et en valeur le contenu du JSON du service account
15-
- Créer dans le proxy une variable nommée *private.credentialsjson* dont la valeur est le contenu du JSON du service account
12+
- A service account that has the rights to call an API on GCP via Oauth
13+
- The JSON of this service account
14+
- Create an entry in the encrypted KVM *gcp-service-account-credentials* with the project name as key and the service account JSON content as value
15+
- Create in the proxy a variable named *private.credentialsjson* whose value is the content of the JSON of the service account
1616

17-
## Fonctionnement
17+
## How to
1818

19-
Ce sharedflow exécute 7 policies d'affilées :
19+
This sharedflow executes 7 policies in a row :
2020
- lc.gcp-token
2121
- js.extract-credentials
2222
- gjwt.generate-JWT
@@ -27,42 +27,42 @@ Ce sharedflow exécute 7 policies d'affilées :
2727

2828
### lc.gcp-token
2929

30-
Cette policy vérifie si une valeur existe dans un cache dont le nom est composé :
31-
- nom de l'organisation
32-
- nom de l'environnement
33-
- nom du proxy
34-
- numéro de la révision
35-
- nom de la target
36-
Si une valeur est trouvée alors on instancie la valeur de la variable _google-credentials.access-token_ avec cette valeur.
37-
Cela permet d'éviter de demander un nouveau token si cette valeur est toujours présente (durée de cache encore valide).
30+
This policy checks if a value exists in a cache whose name is composed :
31+
- Organization name
32+
- Environment name
33+
- Proxy name
34+
- Revision number
35+
- Target name
36+
If a value is found then we instantiate the value of the _google-credentials.access-token_ variable with this value.
37+
This avoids asking for a new token if this value is still present (cache duration still valid).
3838

39-
** Les 4 étapes suivantes ne sont exécutées que si la variable _google-credentials.access-token_ n'est pas vide.**
39+
** The next 4 steps are only executed if the _google-credentials.access-token_ variable is not empty. **
4040

4141
### js.extract-credentials
4242

43-
Cette policy permet d'extraire chaque paire clé/valeur de la variable *private.credentialsjson* (qui contient le contenu du JSON du service account).
43+
This policy extracts each key/value pair from the *private.credentialsjson* variable (which contains the JSON content of the service account).
4444

4545
### gjwt.generate-JWT
4646

47-
Cette policy utilise les informations récupérées pour générer un jeton JWT. Ce jeton est inscrit dans la variable *output_jwt*.
47+
This policy uses the retrieved information to generate a JWT token. This token is written in the variable *output_jwt*.
4848

4949
### sc.gcp-oauth
5050

51-
Cette policy demande à GCP la création d'un jeton OAuth à partir du jeton JWT généré précédemment. Ce jeton est inscrit dans la variable *callout-token*.
51+
This policy asks GCP to create an OAuth token from the previously generated JWT token. This token is written in the variable *callout-token*.
5252

5353
### ev.extract-json
5454

55-
Cette policy extrait le jeton OAuth renvoyé précédemment et crée une variable *google-credentials.access-token*.
55+
This policy extracts the OAuth token returned earlier and creates a variable *google-credentials.access-token*.
5656

5757
### am.add-authorization
5858

59-
Cette policy crée une en-tête *Authorization* dont la valeur est *Bearer * + le contenu de la variable _google-credentials.access-token_.
59+
This policy creates an *Authorization* header whose value is *Bearer * + the content of the _google-credentials.access-token_ variable.
6060

6161
### pc.gcp-token
6262

63-
Cette policy met en cache la valeur de la variable _google-credentials.access-token_ dans un cache dont le nom est composé :
64-
- nom de l'organisation
65-
- nom de l'environnement
66-
- nom du proxy
67-
- numéro de la révision
68-
- nom de la target
63+
This policy caches the value of the _google-credentials.access-token_ variable in a cache whose name is composed :
64+
- Organization name
65+
- Environment name
66+
- Proxy name
67+
- Revision number
68+
- Target name

0 commit comments

Comments
 (0)