154 lines
6.0 KiB
Markdown
154 lines
6.0 KiB
Markdown
# eole-galaxy
|
||
|
||
Utilitaires pour gérer les modules EOLE à partir d’ansible
|
||
|
||
## Alimentation de la configuration de Zéphir
|
||
### zephir_etab
|
||
|
||
Le module a pour but la gestion des établissements.
|
||
Un établissement est identifié par un numéro *rne*.
|
||
|
||
``` plantuml
|
||
object etablissements
|
||
|
||
etablissements : rne (character varying(8) not null pkey)
|
||
etablissements : libelle (character varying(200) not null)
|
||
etablissements : type (integer not null references types_etab)
|
||
etablissements : ville (character varying(50) not null)
|
||
etablissements : cp (character varying(5) not null)
|
||
etablissements : adresse (character varying(100))
|
||
etablissements : tel (character varying(20))
|
||
etablissements : fax (character varying(20))
|
||
etablissements : mail (character varying(100))
|
||
etablissements : responsable (character varying(30))
|
||
etablissements : remarques (text)
|
||
|
||
object types_etab
|
||
|
||
types_etab : id (integer, not null)
|
||
types_etab : libelle (character varying(80), not null)
|
||
```
|
||
|
||
Quoique les champs `libelle`, `type`, `ville`, `cp` soient également obligatoires à la création, ils ne sont pas distinctifs de l’établissement.
|
||
Le champ type fait référence à la table `types_etab` qui contient déjà des valeurs appropriées pour le contexte de l’Éducation nationale.
|
||
Aucune API n’est prévue pour modifier cette table.
|
||
|
||
#### Fonctionnement du module
|
||
|
||
Le module tire partie de l’API XMLRPC authentifiée accessible localement.
|
||
Le module nécessite donc, outre les paramètres attendus par la base de données, des paramètres d’authentification.
|
||
|
||
##### Implémentation cible
|
||
|
||
``` flowchart
|
||
st=>start: Entrée
|
||
e=>end: Sortie
|
||
createproxy=>operation: Création du proxy
|
||
listetabs=>operation: Liste des établissements
|
||
etabexist=>condition: L’établissement existe déjà ?
|
||
samedata=>condition: Les données sont les mêmes ?
|
||
doingnothing=>operation: Ne rien faire
|
||
modifydata=>operation: Modification des données
|
||
createetab=>operation: Création de l’établissement
|
||
|
||
st->createproxy
|
||
createproxy->listetabs
|
||
listetabs->etabexist
|
||
etabexist(yes)->samedata
|
||
samedata(yes)->doingnothing
|
||
doingnothing->e
|
||
samedata(no)->modifydata
|
||
modifydata->e
|
||
etabexist(no)->createetab
|
||
createetab->e
|
||
```
|
||
|
||
##### Implémentation actuelle
|
||
|
||
``` flowchart
|
||
st3=>start: start run_module
|
||
io5=>inputoutput: input:
|
||
op8=>operation: key_mapping = {'rne': 'rne', 'libelle': 'libelle', 'ville': 'ville', 'cp': 'code_postal', 'type': 'etab_type', 'adresse': 'adresse', 'tel': 'tel', 'fax': 'fax', 'mail': 'mail', 'responsable': 'responsable', 'remarques': 'remarques'}
|
||
op10=>operation: module_args = dict(zephir_user=dict(type='str', required=True), zephir_user_password=dict(type='str', required=True), rne=dict(type='str', required=True), libelle=dict(type='str', required=True), ville=dict(type='str', required=True), code_postal=dict(type='str', required=True), etab_type=dict(type='int', required=True), adresse=dict(type='str', required=False, default=''), tel=dict(type='str', required=False, default=''), fax=dict(type='str', required=False, default=''), mail=dict(type='str', required=False, default=''), responsable=dict(type='str', required=False, default=''), remarques=dict(type='str', required=False, default=''), state=dict(type='str', required=True, default='present'))
|
||
op12=>operation: result = dict(changed=False, rne=None, msg='')
|
||
op14=>operation: module = AnsibleModule(argument_spec=module_args, supports_check_mode=True)
|
||
cond17=>operation: module.exit_json(**result) if module.check_mode
|
||
op27=>operation: port_zephir = str((int(config.PORT_ZEPHIR) + 1))
|
||
op29=>operation: proxy_addr = 'http://{0}:{1}@localhost:{2}/'.format(module.params['zephir_user'], module.params['zephir_user_password'], port_zephir)
|
||
op31=>operation: proxy = EoleProxy(proxy_addr)
|
||
op33=>operation: (return_code, etabs) = proxy.etabs.get_etab()
|
||
cond36=>operation: etabs = {m['rne']: m for m in etabs} if return_code
|
||
cond47=>condition: if (module.params['rne'] in etabs)
|
||
op51=>operation: result['msg'] = 'Etab {} already exists'.format(module.params['rne'])
|
||
op53=>operation: data_change = {}
|
||
cond56=>condition: for (key, value) in etabs[module.params['rne']]
|
||
cond73=>operation: data_change[key] = module.params[key_mapping[key]] if (module.params[key_mapping[key]] != value)
|
||
cond86=>operation: module.exit_json(**result) if (not data_change)
|
||
op99=>operation: (return_code, proxy_msg) = proxy.etabs.add_etab(module.params['rne'], module.params['libelle'], module.params['adresse'], module.params['ville'], module.params['code_postal'], module.params['tel'], module.params['fax'], module.params['mail'], module.params['responsable'], module.params['remarques'], module.params['etab_type'])
|
||
cond102=>condition: if return_code
|
||
op106=>operation: result['changed'] = True
|
||
op108=>operation: result['rne'] = proxy_msg
|
||
op110=>operation: result['msg'] = 'Etab {}'.format(module.params['rne'])
|
||
sub119=>subroutine: module.exit_json(**result)
|
||
e121=>end: end run_module
|
||
op114=>operation: result['msg'] = 'Etab {} not created: {}'.format(module.params['libelle'], proxy_msg)
|
||
sub116=>subroutine: module.fail_json(**result)
|
||
|
||
st3->io5
|
||
io5->op8
|
||
op8->op10
|
||
op10->op12
|
||
op12->op14
|
||
op14->cond17
|
||
cond17->op27
|
||
op27->op29
|
||
op29->op31
|
||
op31->op33
|
||
op33->cond36
|
||
cond36->cond47
|
||
cond47(yes)->op51
|
||
op51->op53
|
||
op53->cond56
|
||
cond56(yes)->cond73
|
||
cond73->cond56
|
||
cond56(no)->cond86
|
||
cond86->op99
|
||
op99->cond102
|
||
cond102(yes)->op106
|
||
op106->op108
|
||
op108->op110
|
||
op110->sub119
|
||
sub119->e121
|
||
cond102(no)->op114
|
||
op114->sub116
|
||
sub116->sub119
|
||
cond47(no)->op99
|
||
|
||
```
|
||
|
||
### zephir_serveur
|
||
|
||
### zephir_module
|
||
|
||
### zephir_variante
|
||
|
||
## Configuration d’un serveur
|
||
|
||
### creoleset
|
||
|
||
Le module a pour but de permettre la modification des variables de configuration creole.
|
||
La difficulté réside dans les liens de dépendances qui peuvent exister entre variables et la nécessité de pouvoir faire des modifications par bloc, de façon atomique.
|
||
|
||
``` flowchart
|
||
start=>start: début d’exécution
|
||
e=>end: fin d’exécution
|
||
creole_loader=>operation: Création de l’objet config en lecture/écriture
|
||
tri_variables=>operation: Tri des variables à modifier
|
||
|
||
start->creole_loader
|
||
creole_loader->tri_variables
|
||
tri_variables->e
|
||
```
|
||
|
||
### zephir_register
|