Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(terms-extraction): Set production url #38

Merged
merged 2 commits into from
Jan 26, 2024
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
54 changes: 54 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -413,3 +413,57 @@ automatiquement l'image sur Docker Hub.
> **Remarque**: on peut aussi utiliser l'option *workspace* `-w` de npm pour
> créer la version depuis la racine du dépôt: `npm version -w
> services/service-name patch`.

## Mise en production

Pour la mise en production d'un service, il faut modifier son fichier
`swagger.json`.

Il faut transformer cette partie:

```json
"servers": [
{
"x-comment": "Will be automatically completed by the ezs server."
},
{
"url": "http://vptdmservices.intra.inist.fr:49233/",
"description": "Latest version for production",
"#DISABLED#x-profil": "Standard"
}
],
```

en

```json
"servers": [
{
"x-comment": "Will be automatically completed by the ezs server."
},
{
"url": "http://vptdmservices.intra.inist.fr:49245/",
"description": "Latest version for production",
"x-profil": "Standard"
}
],
```

Où:

1. on enlève `#DISABLED#` devant `x-profil`, en vérifiant que la valeur de ce
champ est bien `Standard`,
2. on ajuste le champ `url` du même objet pour pointer sur l'URL interne du
container sur la machine de production.

> ⚠ Pendant la phase de transition du code source des services web, on publiera
> les services en production à partir du dépôt
> [GitBucket](https://gitbucket.inist.fr/tdm/web-services) où la procédure est
> la même, mais où on supprimera tous les fichiers du services, excepté
> `swagger.json`, qui contiendra les mêmes valeurs que sur GitHub.

Puis, on lance `./bin/publish`, qui demande les *login* et mot de passe de la
machine du *reverse proxy*.

> Le script `./bin/publish` à utiliser pendant la phase de transition est celui
> du GitBucket.
64 changes: 32 additions & 32 deletions services/terms-extraction/swagger.json
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
{
"openapi": "3.0.0",
"info": {
"title": "terms-extraction - Extraction de termes",
"summary": "Extraction de termes à partir de textes en anglais ou en français.",
"version": "1.5.2",
"termsOfService": "https://services.istex.fr/",
"contact": {
"name": "Inist-CNRS",
"url": "https://www.inist.fr/nous-contacter/"
}
},
"servers": [
{
"x-comment": "Will be automatically completed by the ezs server."
},
{
"url": "http://vptdmservices.intra.inist.fr:49225/",
"description": "Latest version for production",
"#DISABLED#x-profil": "Standard"
}
],
"tags": [
{
"name": "terms-extraction",
"description": "Extraction de termes",
"externalDocs": {
"description": "Plus de documentation",
"url": "https://github.com/inist-cnrs/web-services/tree/main/services/terms-extraction"
}
}
]
}
"openapi": "3.0.0",
"info": {
"title": "terms-extraction - Extraction de termes",
"summary": "Extraction de termes à partir de textes en anglais ou en français.",
"version": "1.5.2",
"termsOfService": "https://services.istex.fr/",
"contact": {
"name": "Inist-CNRS",
"url": "https://www.inist.fr/nous-contacter/"
}
},
"servers": [
{
"x-comment": "Will be automatically completed by the ezs server."
},
{
"url": "http://vptdmservices.intra.inist.fr:49245/",
"description": "Latest version for production",
"x-profil": "Standard"
}
],
"tags": [
{
"name": "terms-extraction",
"description": "Extraction de termes",
"externalDocs": {
"description": "Plus de documentation",
"url": "https://github.com/inist-cnrs/web-services/tree/main/services/terms-extraction"
}
}
]
}