first commit

This commit is contained in:
Emmanuel Garette 2019-11-28 14:50:53 +01:00
commit 37499daccf
165 changed files with 4995 additions and 0 deletions

6
.gitignore vendored Normal file
View File

@ -0,0 +1,6 @@
# Backup and swap files
*~
*#
*.swp
*.pyc
__pycache__

View File

@ -0,0 +1,19 @@
---
uri: config.configuration.server.deploy
description: |
Déployer la configuration d'un serveur.
sampleuse: ~
pattern: event
public: false
domain: config-domain
parameters:
server_id:
type: Number
description: |
Identifiant du serveur.

View File

@ -0,0 +1,28 @@
---
uri: config.configuration.server.get
description: |
Récupère le contenu de la configuration.
sampleuse: ~
pattern: rpc
public: false
domain: config-domain
parameters:
server_id:
type: Number
ref: Server.ServerId
description: |
Identifiant de la configuration.
deploy:
type: Boolean
description: Configuration de type déployée.
response:
type: ConfigConfiguration
description: |
Contenu de la configuration.

View File

@ -0,0 +1,26 @@
---
uri: config.session.server.start
description: |
Démarre une session de configuration pour un serveur.
sampleuse: |
zephir-client config.session.server.start -c 2
pattern: rpc
public: true
domain: config-domain
parameters:
id:
type: Number
ref: Server.ServerId
shortarg: c
description: |
Identifiant de la configuration.
response:
type: ConfigSession
description: Description de la session.

View File

@ -0,0 +1,30 @@
---
uri: config.session.server.stop
description: |
Termine une session de configuration d'un serveur.
sampleuse: |
zephir-client config.session.server.stop -s xxxxx
pattern: rpc
public: true
domain: config-domain
parameters:
sessionid:
ref: Config.SessionId
type: String
shortarg: s
description: Identifiant de la session.
save:
type: Boolean
shortarg: a
description: Sauver la configuration avant de la terminer.
default: false
response:
type: ConfigSession
description: Description de la session.

View File

@ -0,0 +1,22 @@
---
uri: config.configuration.server.updated
description: |
Une configuration de serveur a été mise à jour.
sampleuse: ~
pattern: event
public: false
domain: config-domain
parameters:
server_id:
type: Number
description: |
Identifiant du serveur.
deploy:
type: Boolean
description: Configuration de type déployée.

View File

@ -0,0 +1,25 @@
---
uri: config.session.error.locked
sampleuse: ~
description: |
Une erreur est survenue lors de la tentative douverture dune session existante.
public: true
pattern: error
parameters:
reason:
type: String
description: Message de lerreur lisible par un humain.
sessionid:
type: String
description: Identifiant de la session existante.
ref: Config.SessionId
username:
type: String
description: Nom de lutilisateur propriétaire de la session existante.
domain: config-domain

View File

@ -0,0 +1,43 @@
---
uri: config.session.server.configure
description: |
Configure le server.
sampleuse: |
zephir-client config.session.server.configure -s 2
pattern: rpc
public: true
domain: config-domain
parameters:
session_id:
type: String
ref: Config.SessionId
shortarg: s
description: Identifiant de la configuration.
action:
type: String
shortarg: a
description: Action sur la variable ("modify", "delete", "add").
name:
type: String
shortarg: n
description: Nom de la variable a modifier.
index:
type: Number
shortarg: i
description: Index de la variable a modifier.
default: null
value:
type: Any
shortarg: v
description: Valeur de la variable.
default: null
response:
type: ConfigStatus
description: Description de la session.

View File

@ -0,0 +1,40 @@
---
uri: config.session.server.filter
description: |
Filter la configuration a éditer.
sampleuse: |
zephir-client config.session.server.filter -s 2
pattern: rpc
public: true
domain: config-domain
parameters:
session_id:
type: String
ref: Config.SessionId
shortarg: s
description: Identifiant de la configuration.
namespace:
type: String
shortarg: n
description: Nom du namespace de la configuration.
default: null
mode:
type: String
shortarg: m
description: Mode de la configuration (basic, normal, expert).
default: null
debug:
type: Boolean
shortarg: d
description: Activation du mode debug.
default: null
response:
type: ConfigSession
description: Description de la session.

View File

@ -0,0 +1,25 @@
---
uri: config.session.server.get
description: |
Configure le server.
sampleuse: |
zephir-client config.session.server.get -s 2
pattern: rpc
public: true
domain: config-domain
parameters:
session_id:
type: String
ref: Config.SessionId
shortarg: s
description: Identifiant de la configuration.
response:
type: ConfigSession
description: Description de la session.

View File

@ -0,0 +1,19 @@
---
uri: config.session.server.list
description: |
Liste les sessions de configuration des serveurs.
sampleuse: |
zephir-client config.session.server.list
pattern: rpc
public: true
domain: config-domain
response:
type: '[]ConfigSession'
description: |
Liste des sessions.

View File

@ -0,0 +1,26 @@
---
uri: config.session.server.validate
description: |
Valider la configuration d'un serveur.
sampleuse: |
zephir-client config.session.server.validate -s xxxxx
pattern: rpc
public: true
domain: config-domain
parameters:
session_id:
ref: Config.SessionId
type: String
shortarg: s
description: Identifiant de la session.
response:
type: ConfigConfigurationStatus
description: Statut de la configuration.

View File

@ -0,0 +1,43 @@
---
uri: config.session.servermodel.configure
description: |
Configure le servermodel.
sampleuse: |
zephir-client config.session.servermodel.configure -s 2
pattern: rpc
public: true
domain: config-domain
parameters:
session_id:
type: String
ref: Config.SessionId
shortarg: s
description: Identifiant de la configuration.
action:
type: String
shortarg: a
description: Action sur la variable ("modify", "delete", "add").
name:
type: String
shortarg: n
description: Nom de la variable a modifier.
index:
type: Number
shortarg: i
description: Index de la variable a modifier.
default: null
value:
type: Any
shortarg: v
description: Valeur de la variable.
default: null
response:
type: ConfigStatus
description: Description de la session.

View File

@ -0,0 +1,40 @@
---
uri: config.session.servermodel.filter
description: |
Filter la configuration a éditer.
sampleuse: |
zephir-client config.session.servermodel.filter -s 2
pattern: rpc
public: true
domain: config-domain
parameters:
session_id:
type: String
ref: Config.SessionId
shortarg: s
description: Identifiant de la configuration.
namespace:
type: String
shortarg: n
description: Nom du namespace de la configuration.
default: null
mode:
type: String
shortarg: m
description: Mode de la configuration (basic, normal, expert).
default: null
debug:
type: Boolean
shortarg: d
description: Activation du mode debug.
default: null
response:
type: ConfigSession
description: Description de la session.

View File

@ -0,0 +1,25 @@
---
uri: config.session.servermodel.get
description: |
Configure le servermodel.
sampleuse: |
zephir-client config.session.servermodel.get -s 2
pattern: rpc
public: true
domain: config-domain
parameters:
session_id:
type: String
ref: Config.SessionId
shortarg: s
description: Identifiant de la configuration.
response:
type: ConfigSession
description: Description de la session.

View File

@ -0,0 +1,18 @@
uri: config.session.servermodel.list
description: |
Liste les sessions de configuration des modèles de serveur.
sampleuse: |
zephir-client config.session.servermodel.list
pattern: rpc
public: true
domain: config-domain
response:
type: '[]ConfigSession'
description: |
Liste des sessions.

View File

@ -0,0 +1,25 @@
uri: config.session.servermodel.start
description: |
Démarre une session de configuration pour un modèle de serveur.
sampleuse: |
zephir-client config.session.servermodel.start -c 2
pattern: rpc
public: true
domain: config-domain
parameters:
id:
type: Number
ref: Servermodel.ServermodelId
shortarg: c
description: |
Identifiant de la configuration.
response:
type: ConfigSession
description: Description de la session.

View File

@ -0,0 +1,29 @@
uri: config.session.servermodel.stop
description: |
Termine une session de configuration d'un modèle de serveur.
sampleuse: |
zephir-client config.session.servermodel.stop -s xxxxx
pattern: rpc
public: true
domain: config-domain
parameters:
sessionid:
ref: Config.SessionId
type: String
shortarg: s
description: Identifiant de la session.
save:
type: Boolean
shortarg: a
description: Sauver la configuration avant de la terminer.
default: false
response:
type: ConfigSession
description: Description de la session.

View File

@ -0,0 +1,26 @@
---
uri: config.session.servermodel.validate
description: |
Valider la configuration d'un modèle serveur.
sampleuse: |
zephir-client config.session.servermodel.validate -s xxxxx
pattern: rpc
public: true
domain: config-domain
parameters:
session_id:
ref: Config.SessionId
type: String
shortarg: s
description: Identifiant de la session.
response:
type: ConfigConfigurationStatus
description: Statut de la configuration.

View File

@ -0,0 +1,19 @@
---
uri: datasource.available
sampleuse: ~
description: |
Annonce la disponibilité dune source de données.
pattern: event
public: false
domain: datasource-domain
parameters:
datasourceurl:
type: String
description: |
Adresse de la source de données.

View File

@ -0,0 +1,23 @@
---
uri: execution.salt.configuration.deploy-scheduled
sampleuse: ~
description: |
Le déploiement de la configuration est planifié par SaltStack.
public: false
pattern: event
parameters:
return:
type: Dict
description: Valeur de retour de salt-api.
domain: execution-domain
related:
- execution.salt.configuration.deploy
- execution.salt.job.list
- execution.salt.job.describe

View File

@ -0,0 +1,33 @@
---
uri: execution.salt.configuration.deploy
description: |
Déploie les fichiers de configuration EOLE sur des minions.
sampleuse: ~
domain: execution-domain
pattern: rpc
public: false
parameters:
minion_pattern:
type: String
description: Patron de sélection des minions.
help: Le patron de sélection est au format glob.
response:
type: 'SaltExec'
description: Liste des tâches planifiées par SaltStack.
errors:
- uri: execution.salt.exec.error.missing-minion_pattern
- uri: execution.salt.exec.error.login
- uri: execution.salt.exec.error.execute
related:
- execution.salt.configuration.deploy-scheduled
- execution.salt.job.list
- execution.salt.job.describe

View File

@ -0,0 +1,21 @@
---
uri: execution.salt.configuration.missing
sampleuse: ~
description: |
La configuration du serveur nexiste pas.
public: true
pattern: error
parameters:
reason:
type: String
description: Message derreur lisible par un humain.
domain: execution-domain
related:
- execution.salt.configuration.deploy

View File

@ -0,0 +1,22 @@
---
uri: execution.salt.environment.get
description: Récupère les données d'environnement d'un serveur.
sampleuse: ~
domain: execution-domain
pattern: rpc
public: false
parameters:
server_id:
type: Number
ref: Server.ServerId
description: Identifiant du serveur.
response:
type: Dict
description: Données d'environnement.

View File

@ -0,0 +1,22 @@
---
uri: execution.salt.exec.command-executed
sampleuse: ~
description: |
Lexécution dune commande est correctement planifiée par SaltStack.
public: false
pattern: event
parameters:
type: 'SaltExec'
description: Liste des tâches planifiées par SaltStack.
domain: execution-domain
related:
- execution.salt.exec
- execution.salt.job.list
- execution.salt.job.describe

View File

@ -0,0 +1,21 @@
---
uri: execution.salt.exec.error.execute
sampleuse: ~
description: |
Une demande dexécution a retourné un code derreur.
public: true
pattern: error
parameters:
reason:
type: String
description: Message de lerreur lisible par un humain.
domain: execution-domain
related:
- execution.salt.exec

View File

@ -0,0 +1,21 @@
---
uri: execution.salt.exec.error.login
sampleuse: ~
description: |
Une erreur est survenue lors de la connexion à « salt-api ».
public: true
pattern: error
parameters:
reason:
type: String
description: Message de lerreur lisible par un humain.
domain: execution-domain
related:
- execution.salt.exec

View File

@ -0,0 +1,21 @@
---
uri: execution.salt.exec.error.missing-command
sampleuse: ~
description: |
Largument « Command » n'a pas été fourni.
public: true
pattern: error
parameters:
reason:
type: String
description: Message de lerreur lisible par un humain.
domain: execution-domain
related:
- execution.salt.exec

View File

@ -0,0 +1,21 @@
---
uri: execution.salt.exec.error.missing-minion_pattern
sampleuse: ~
description: |
Largument « MinionPattern » n'a pas été fourni.
public: true
pattern: error
parameters:
reason:
type: String
description: Message derreur lisible par un humain.
domain: execution-domain
related:
- execution.salt.exec

View File

@ -0,0 +1,65 @@
---
uri: execution.salt.exec
description: |
Planifie lexécution dune commande sur des minions.
sampleuse: ~
domain: execution-domain
pattern: rpc
public: false
parameters:
minion_pattern:
type: String
description: Patron de sélection des minions.
help: Le patron de sélection est au format glob.
command:
type: String
description: Commande SaltStack à exécuter.
arg:
type: String
description: Arguments de la commande SaltStack.
default: null
client_mode:
type: String
description: Mode dexécution des commandes SaltStack.
help: |
Utiliser un des modes de communication parmi :
- « local »
- « local_async »
default: local_async
tgt_type:
type: String
description: Type de cible de la commande.
help: |
valeurs possibles :
glob - Bash glob completion - Default
pcre - Perl style regular expression
list - Python list of hosts
grain - Match based on a grain comparison
grain_pcre - Grain comparison with a regex
pillar - Pillar data comparison
pillar_pcre - Pillar data comparison with a regex
nodegroup - Match on nodegroup
range - Use a Range server for matching
compound - Pass a compound match string
ipcidr - Match based on Subnet (CIDR notation) or IPv4 address.
default: glob
response:
type: 'SaltExec'
description: Retour de la tâche planifiée par SaltStack.
errors:
- uri: execution.salt.exec.error.missing-command
- uri: execution.salt.exec.error.missing-minion_pattern
- uri: execution.salt.exec.error.login
- uri: execution.salt.exec.error.execute
related:
- execution.salt.job.list
- execution.salt.job.describe

View File

@ -0,0 +1,33 @@
---
uri: execution.salt.job.describe
description: |
Retourne les attributs détaillés dune tâche SaltStack.
sampleuse: ~
domain: execution-domain
pattern: rpc
public: false
parameters:
jid:
type: String
ref: Server.JobId
description: Identifiant de la tâche SaltStack.
response:
type: '[]SaltJob'
description: Liste des tâches SaltStack pour chaque minion avec leurs attributs détaillés.
errors:
- uri: execution.salt.job.error.db-connection
- uri: execution.salt.job.error.missing-jid
- uri: execution.salt.job.error.jid-type
- uri: execution.salt.job.error.unknown-jid
related:
- execution.salt.job.list
- execution.salt.exec

View File

@ -0,0 +1,22 @@
---
uri: execution.salt.job.error.db-connection
sampleuse: ~
description: |
Une erreur est survenue lors de la connexion à la base de données.
public: true
pattern: error
parameters:
reason:
type: String
description: Message derreur lisible par un humain.
domain: execution-domain
related:
- execution.salt.job.list
- execution.salt.job.describe

View File

@ -0,0 +1,21 @@
---
uri: execution.salt.job.error.jid-type
sampleuse: ~
description: |
Mauvais type fourni pour largument « JID ».
public: true
pattern: error
parameters:
reason:
type: String
description: Message derreur lisible par un humain.
domain: execution-domain
related:
- execution.salt.job.describe

View File

@ -0,0 +1,21 @@
---
uri: execution.salt.job.error.list
sampleuse: ~
description: |
Une erreur est survenue lors de la constrution de la liste des tâches.
public: true
pattern: error
parameters:
reason:
type: String
description: Message derreur lisible par un humain.
domain: execution-domain
related:
- execution.salt.job.list

View File

@ -0,0 +1,21 @@
---
uri: execution.salt.job.error.missing-jid
sampleuse: ~
description: |
Argument « JID » manquant.
public: true
pattern: error
parameters:
reason:
type: String
description: Message derreur lisible par un humain.
domain: execution-domain
related:
- execution.salt.job.describe

View File

@ -0,0 +1,21 @@
---
uri: execution.salt.job.error.unknown-jid
sampleuse: ~
description: |
Lidentifiant de tâche est inconnu de SalStack.
public: true
pattern: error
parameters:
reason:
type: String
description: Message derreur lisible par un humain.
domain: execution-domain
related:
- execution.salt.job.describe

View File

@ -0,0 +1,33 @@
---
uri: execution.salt.job.list
description: |
Retourne la liste de toutes les tâches SaltStack d'un minion.
sampleuse: ~
domain: execution-domain
pattern: rpc
public: false
parameters:
minion_pattern:
type: String
description: Nom du minion.
command:
type: String
description: Commande SaltStack à exécuter.
response:
type: '[]SaltJob'
description: Liste des tâches SalStack.
errors:
- uri: execution.salt.job.error.db-connection
- uri: execution.salt.job.error.list
related:
- execution.salt.job.describe
- execution.salt.exec

View File

@ -0,0 +1,17 @@
---
uri: execution.salt.master.event.ready
sampleuse: ~
description: Le minion est prêt.
public: false
pattern: event
domain: execution-domain
parameters:
server_id:
type: Number
description: Identifiant du serveur.

View File

@ -0,0 +1,17 @@
---
uri: execution.salt.master.event.start
sampleuse: ~
description: Un minion a démarré.
public: false
pattern: event
domain: execution-domain
parameters:
server_id:
type: Number
description: Identifiant du serveur.

View File

@ -0,0 +1,19 @@
---
uri: execution.salt.minion.registered
sampleuse: ~
description: |
TODO: Un nouveau minion est attaché à l'instance saltmaster utilisée par l'application Zéphir.
public: false
pattern: event
domain: execution-domain
parameters:
saltminionid:
type: String
description: |
Identifiant interne du minion Salt distant.

View File

@ -0,0 +1,19 @@
---
uri: execution.salt.minion.unregistered
sampleuse: ~
description: |
TODO: Un minion est détaché de l'instance saltmaster utilisée par l'application Zéphir.
public: false
pattern: event
domain: execution-domain
parameters:
saltminionid:
type: String
description: |
Identifiant interne du minion Salt distant.

View File

@ -0,0 +1,21 @@
---
uri: execution.salt.peer.error
sampleuse: ~
description: |
Un appairage Saltstack sest terminé avec un code derreur.
public: true
pattern: error
parameters:
reason:
type: String
description: Message derreur lisible par un humain.
domain: server-domain
related:
- execution.salt.peer

View File

@ -0,0 +1,21 @@
---
uri: execution.salt.peer.registered
sampleuse: ~
description: |
Un appairage Saltstack a eu lieu.
pattern: event
parameters:
serverid:
type: Number
description: Identifiant du serveur et du minion salt.
automation:
type: String
description: moteur d'Automatisation.
public: false
domain: execution-domain

View File

@ -0,0 +1,18 @@
---
uri: identity.session-user.get
description: |
Retourne des informations sur la session HTTP courante de l'utilisateur.
sampleuse: |
zephir-client identity.session-user.get
pattern: rpc
public: true
domain: identity-domain
response:
type: IdentitySession
description: Informations sur l'identité de l'utilisateur.

View File

@ -0,0 +1,25 @@
---
uri: identity.settings.get
description: |
Retourne les préférences de l'utilisateur spécifié.
sampleuse: |
zephir-client identity.settings.get -u yo
pattern: rpc
public: true
domain: identity-domain
parameters:
username:
type: String
ref: Identity.username
shortarg: u
description: Identifiant de l'utilisateur.
response:
type: IdentitySettings
description: Préférences de l'utilisateur.

View File

@ -0,0 +1,50 @@
---
uri: identity.settings.set
description: |
Enregistre des préférences pour l'utilisateur spécifié.
sampleuse: |
zephir-client identity.settings.set -u yo
pattern: rpc
public: true
domain: identity-domain
parameters:
username:
type: String
ref: Identity.username
shortarg: u
description: Identifiant de l'utilisateur.
sshkey:
type: String
shortarg: s
description: Clé publique ssh.
default: null
firstname:
type: String
shortarg: f
description: Prénom de l'utilisateur.
default: null
lastname:
type: String
shortarg: l
description: Nom de l'utilisateur.
default: null
email:
type: String
shortarg: m
description: Adresse email de l'utilisateur.
default: null
alertes:
type: Boolean
shortarg: a
description: Activer les alertes email.
default: null
response:
type: IdentitySettings
description: Informations sur l'identité de l'utilisateur.

View File

@ -0,0 +1,18 @@
---
uri: identity.settings.updated
description: |
Des préférences ont été modifiées
sampleuse: ~
pattern: event
public: false
domain: identity-domain
parameters:
settings:
type: Dict
description: Préférences de l'utilisateur.

View File

@ -0,0 +1,19 @@
---
uri: server.configuration.updated
sampleuse: ~
description: |
La configuration d'un serveur a été modifié.
pattern: event
public: false
domain: server-domain
parameters:
server_id:
type: Number
description: |
Identifiant du serveur.

View File

@ -0,0 +1,54 @@
---
uri: server.create
description: |
Crée un serveur.
sampleuse: |
zephir-client server.create -s MonJoliServeur -d "un bien joli serveur" -m 1 -p MyPassPhrase
pattern: rpc
public: true
domain: server-domain
parameters:
servername:
type: String
shortarg: s
description: |
Nom du serveur.
serverdescription:
type: String
shortarg: d
description: |
Description du serveur.
servermodelid:
type: Number
shortarg: m
ref: Servermodel.ServermodelId
description: |
Identifiant du modèle de serveur.
serverpassphrase:
type: String
shortarg: p
description: |
Phrase secrète de la clef privé.
response:
type: Server
description: Description du serveur créé.
errors:
- uri: server.error.database-not-available
- uri: server.error.db-connection
- uri: server.error.invalid-servermodel-id
- uri: server.error.unknown-servermodel-id
- uri: server.error.servername-not-provided
related:
- server.list
- server.describe
- server.update
- server.delete

View File

@ -0,0 +1,14 @@
---
uri: server.created
description: Un serveur a été créé.
pattern: event
public: false
domain: server-domain
parameters:
type: Server
description: Description du serveur.

View File

@ -0,0 +1,38 @@
---
uri: server.delete
description: |
Supprime un serveur.
public: true
pattern: rpc
domain: server-domain
sampleuse: |
zephir-client server.delete -s 1
parameters:
serverid:
type: Number
ref: Server.ServerId
shortarg: s
description: |
Identifiant du serveur.
response:
type: Server
description: Description du serveur supprimé.
errors:
- uri: server.error.database-not-available
- uri: server.error.db-connection
- uri: server.error.invalid-server-id
- uri: server.error.unknown-server-id
related:
- server.list
- server.describe
- server.create
- server.update

View File

@ -0,0 +1,19 @@
---
uri: server.deleted
sampleuse: ~
description: |
Un serveur a été supprimé.
pattern: event
public: false
domain: server-domain
parameters:
serverid:
type: Number
description: |
Identifiant du serveur supprimé.

View File

@ -0,0 +1,49 @@
---
uri: server.describe
description: |
Retourne les attributs détaillés dun serveur.
sampleuse: |
zephir-client server.describe -s 1
pattern: rpc
public: true
domain: server-domain
parameters:
serverid:
type: Number
ref: Server.ServerId
description: Identifiant du serveur.
shortarg: s
configuration:
type: Boolean
description: Inclure les valeurs de configuration.
default: false
environment:
type: Boolean
description: Inclure les variables d'environement.
default: false
peering:
type: Boolean
description: Inclure la clé d'appairage.
default: false
response:
type: ServerDescribe
description: Description du serveur.
errors:
- uri: server.error.database-not-available
- uri: server.error.db-connection
- uri: server.error.invalid-server-id
- uri: server.error.unknown-server-id
related:
- server.list
- server.create
- server.update
- server.delete

View File

@ -0,0 +1,18 @@
---
uri: server.environment.updated
description: Les données d'environnements d'un serveur sont modifiées
sampleuse: ~
pattern: event
public: false
domain: config-domain
parameters:
server_id:
type: Number
description: |
Identifiant de la configuration.

View File

@ -0,0 +1,25 @@
---
uri: server.error.database-not-available
sampleuse: ~
description: |
Aucun service de base de données disponible.
public: true
pattern: error
parameters:
reason:
type: String
description: Message de lerreur lisible par un humain.
domain: server-domain
related:
- server.list
- server.describe
- server.create
- server.update
- server.delete

View File

@ -0,0 +1,25 @@
---
uri: server.error.db-connection
sampleuse: ~
description: |
Erreur de connexion à la base de données.
public: true
pattern: error
parameters:
reason:
type: String
description: Message de lerreur lisible par un humain.
domain: server-domain
related:
- server.list
- server.describe
- server.create
- server.update
- server.delete

View File

@ -0,0 +1,23 @@
---
uri: server.error.invalid-server-id
sampleuse: ~
description: |
Identifiant de serveur invalide.
public: true
pattern: error
parameters:
reason:
type: String
description: Message de lerreur lisible par un humain.
domain: server-domain
related:
- server.describe
- server.update
- server.delete

View File

@ -0,0 +1,21 @@
---
uri: server.error.invalid-servermodel-id
sampleuse: ~
description: |
Identifiant de modèle de serveur invalide.
public: true
pattern: error
parameters:
reason:
type: String
description: Message de lerreur lisible par un humain.
domain: server-domain
related:
- server.create

View File

@ -0,0 +1,21 @@
---
uri: server.error.peering-conf-not-available
sampleuse: ~
description: |
Pas de configuration d'appairage disponible.
public: true
pattern: error
parameters:
reason:
type: String
description: Message de lerreur lisible par un humain.
domain: server-domain
related:
- server.get-peering-conf

View File

@ -0,0 +1,22 @@
---
uri: server.error.servername-not-provided
sampleuse: ~
description: |
ServerName non fourni.
public: true
pattern: error
parameters:
reason:
type: String
description: Message de lerreur lisible par un humain.
domain: server-domain
related:
- server.create
- server.update

View File

@ -0,0 +1,23 @@
---
uri: server.error.unknown-server-id
sampleuse: ~
description: |
Identifiant de serveur inconnu.
public: true
pattern: error
parameters:
reason:
type: String
description: Message de lerreur lisible par un humain.
domain: server-domain
related:
- server.describe
- server.update
- server.delete

View File

@ -0,0 +1,21 @@
---
uri: server.error.unknown-servermodel-id
sampleuse: ~
description: |
Identifiant de modèle de serveur inconnu.
public: true
pattern: error
parameters:
reason:
type: String
description: Message de lerreur lisible par un humain.
domain: server-domain
related:
- server.create

View File

@ -0,0 +1,25 @@
---
uri: server.error.db-connection
sampleuse: ~
description: |
Erreur inconnue recontrée par le gestionnaire de serveurs.
public: true
pattern: error
parameters:
reason:
type: String
description: Message de lerreur lisible par un humain.
domain: server-domain
related:
- server.list
- server.describe
- server.create
- server.update
- server.delete

View File

@ -0,0 +1,38 @@
---
uri: server.exec.command
description: |
Transmet une commande à exécuter sur un serveur donné.
sampleuse: |
zephir-client server.exec.command -s 1 -c reconfigure
domain: server-domain
pattern: rpc
public: true
parameters:
server_id:
type: Number
description: Identifiant du serveur sur lequel la commande sera exécutée.
ref: Server.ServerId
shortarg: s
command:
type: String
description: Commande à exécuter.
ref: salt.exec.availablecommands
shortarg: c
response:
type: ServerExec
description: La commande exécutée.
errors:
- uri: server.exec.error.missing-command
- uri: server.exec.error.unmanaged-server
related:
- server.exec.error.missing-command
- server.exec.error.unmanaged-server

View File

@ -0,0 +1,25 @@
---
uri: server.exec.deploy
description: |
Déploie la configuration sur un serveur donné.
sampleuse: |
zephir-client server.exec.deploy -s 1
domain: server-domain
pattern: rpc
public: true
parameters:
server_id:
type: Number
description: Identifiant du serveur.
ref: Server.ServerId
shortarg: s
response:
type: ServerExec
description: La commande exécutée.

View File

@ -0,0 +1,31 @@
---
uri: server.exec.describe
description: |
Liste les commandes exécuté pour un identifiant de tâche.
sampleuse: |
zephir-client server.exec.list -j 1
domain: execution-domain
pattern: rpc
public: true
parameters:
job_id:
type: String
description: Identifiant de la tâche.
ref: Server.JobId
shortarg: j
automation:
type: String
description: Moteur d'exécution.
ref: Server.automation
shortarg: a
response:
type: "[]ServerExec"
description: Liste des commandes exécutées.

View File

@ -0,0 +1,21 @@
---
uri: server.exec.error.missing-command
sampleuse: ~
description: |
Paramètre "command" manquant.
public: true
pattern: error
parameters:
reason:
type: String
description: Message de lerreur lisible par un humain.
domain: server-domain
related:
- server.exec

View File

@ -0,0 +1,21 @@
---
uri: server.exec.error.unmanaged-server
sampleuse: ~
description: |
Le serveur n'est pas associé à un gestionnaire d'exécution.
public: true
pattern: error
parameters:
reason:
type: String
description: Message de lerreur lisible par un humain.
domain: server-domain
related:
- server.exec

View File

@ -0,0 +1,25 @@
---
uri: server.exec.list
description: |
Liste les commandes exécutées sur un serveur donné.
sampleuse: |
zephir-client server.exec.list -s 1
domain: execution-domain
pattern: rpc
public: true
parameters:
server_id:
type: Number
description: Identifiant du serveur.
ref: Server.ServerId
shortarg: s
response:
type: "[]ServerExec"
description: Liste des commandes exécutées.

View File

@ -0,0 +1,23 @@
---
uri: server.executed
sampleuse: ~
description: |
La commande a été lancée sur le serveur.
pattern: event
public: false
domain: server-domain
parameters:
arguments:
type: Dict
description: |
Liste des arguments utilisés.
return:
type: Dict
description: |
Retour du message.

View File

@ -0,0 +1,18 @@
---
uri: server.list
description: |
Liste les serveurs disponibles.
sampleuse: |
zephir-client server.list
public: true
pattern: rpc
domain: server-domain
response:
type: '[]Server'
description: Retourne la liste des serveurs.

View File

@ -0,0 +1,35 @@
---
uri: server.peer-connection.update
description: Met à jour la date de dernière connexion d'un serveur.
public: false
sampleuse: ~
pattern: rpc
domain: server-domain
parameters:
serverid:
type: Number
ref: Server.ServerId
description: Identifiant du serveur.
response:
type: Boolean
description: La mise à jour a réussi.
errors:
- uri: server.error.database-not-available
- uri: server.error.db-connection
- uri: server.error.invalid-server-id
- uri: server.error.unknown-server-id
- uri: server.error.servername-not-provided
related:
- servermodel.list
- servermodel.describe
- servermodel.create
- servermodel.delete

View File

@ -0,0 +1,18 @@
---
uri: server.salt.registered
sampleuse: ~
description: |
Un serveur a été appairé
pattern: event
parameters:
serverid:
type: Number
description: Identifiant du server.
public: false
domain: server-domain

View File

@ -0,0 +1,33 @@
---
uri: server.serverselection.list
description: |
Retourne la liste des sélections de serveurs d'un serveur
sampleuse: |
zephir-client server.serverselection.list
pattern: rpc
public: true
domain: server-domain
parameters:
serverid:
type: Number
ref: Server.ServerId
description: Identifiant du serveur.
shortarg: s
response:
type: '[]ServerSelection'
description: List des sélections de serveurs d'un serveur
errors:
- uri: server.error.database_not_available
related:
- serverselection.describe
- serverselection.create
- serverselection.delete

View File

@ -0,0 +1,21 @@
---
uri: server.storage.event
sampleuse: ~
description: |
Notifie l'ajout/suppression/modification d'un fichier dans le container minio.
pattern: event
parameters:
key:
type: String
description: Chemin du fichier stocké (<bucket>/<objet>).
event_type:
type: String
description: Type d'évènement remonté (s3:ObjectCreated:Put, s3:ObjectRemoved:Delete).
public: false
domain: server-domain

View File

@ -0,0 +1,49 @@
---
uri: server.update
description: |
Modifie un serveur.
public: true
sampleuse: |
zephir-client server.update -s 1 -n toto -d "server description"
pattern: rpc
domain: server-domain
parameters:
serverid:
type: Number
ref: Server.ServerId
description: |
Identifiant du serveur.
shortarg: s
servername:
type: String
description: |
Nouveau nom du serveur.
shortarg: n
serverdescription:
type: String
description: |
Nouvelle description du serveur.
shortarg: d
response:
type: Server
description: Description du serveur mis à jour.
errors:
- uri: server.error.database-not-available
- uri: server.error.db-connection
- uri: server.error.invalid-server-id
- uri: server.error.unknown-server-id
- uri: server.error.servername-not-provided
related:
- servermodel.list
- servermodel.describe
- servermodel.create
- servermodel.delete

View File

@ -0,0 +1,19 @@
---
uri: server.updated
sampleuse: ~
description: |
Un serveur a été modifié.
pattern: event
public: false
domain: server-domain
parameters:
serverid:
type: Number
description: |
Identifiant du serveur.

View File

@ -0,0 +1,31 @@
---
uri: servermodel.applicationservice.join
description: |
Associe un service applicatif à un modèle de serveur.
sampleuse: |
zephir-client servermodel.applicationservice.join -m 1 -s 1
pattern: rpc
public: true
domain: servermodel-domain
parameters:
servermodelid:
type: Number
shortarg: m
description: |
Identifiant du modèle de serveur.
applicationserviceid:
type: Number
shortarg: s
description: |
Identifiant du service applicatif.
response:
type: Servermodel
description: Description du modèle de serveur.

View File

@ -0,0 +1,25 @@
---
uri: servermodel.applicationservice.list
description: |
Retourne la liste des applications service.
sampleuse: |
zephir-client servermodel.applicationservice.list -s 6
pattern: rpc
public: true
domain: servermodel-domain
parameters:
subreleaseid:
type: Number
shortarg: s
description: |
Identifiant de la sous-release.
response:
type: '[]Dict'
description: Liste des applications service disponibles.

View File

@ -0,0 +1,19 @@
---
uri: servermodel.create.error.database_not_available
sampleuse: ~
description: |
Erreur retournée lorsque la base de données n'est pas disponible.
public: true
pattern: error
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur.
domain: servermodel-domain

View File

@ -0,0 +1,19 @@
---
uri: servermodel.create.error.duplicate_servermodel
sampleuse: ~
description: |
La combinaison nom/source/version/release existe déjà.
public: true
pattern: error
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur.
domain: servermodel-domain

View File

@ -0,0 +1,19 @@
---
uri: servermodel.create.error.invalid_parentservermodel_id
sampleuse: ~
description: |
L'identifiant ServerModelId du parent n'est pas un entier.
public: true
pattern: error
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur.
domain: servermodel-domain

View File

@ -0,0 +1,19 @@
---
uri: servermodel.create.error.invalid_source_id
sampleuse: ~
description: |
L'identifiant ServerModelSourceId n'est pas un entier.
public: true
pattern: error
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur.
domain: servermodel-domain

View File

@ -0,0 +1,19 @@
---
uri: servermodel.create.error.servermodelname_not_provided
sampleuse: ~
description: |
Le nom du modèle de serveur n'est pas fourni.
public: true
pattern: error
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur.
domain: servermodel-domain

View File

@ -0,0 +1,19 @@
---
uri: servermodel.create.error.unknown_parentservermodel_id
sampleuse: ~
description: |
L'identifiant ServerModelId du parent ne correspond a aucun enregistrement dans la base.
public: true
pattern: error
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur.
domain: servermodel-domain

View File

@ -0,0 +1,19 @@
---
uri: servermodel.create.error.unknown_parentservermodel_id
sampleuse: ~
description: |
L'identifiant SourceId ne correspond a aucun enregistrement dans la base.
public: true
pattern: error
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur.
domain: servermodel-domain

View File

@ -0,0 +1,52 @@
---
uri: servermodel.create
description: |
Crée un modèle de serveur.
sampleuse: |
zephir-client servermodel.create -p 1 -n "MonServeurModele" -d "Ma description" -s 1
pattern: rpc
public: true
domain: servermodel-domain
parameters:
servermodelparentsid:
type: "[]Number"
ref: Servermodel.ServermodelId
shortarg: p
description: |
Identifiants des modèles de serveur parents auquels rattacher le nouveau modèle.
servermodelname:
type: String
shortarg: n
description: |
Nom du modèle de serveur à créer.
servermodeldescription:
type: String
shortarg: d
description: |
Description du modèle de serveur à créer.
response:
type: Servermodel
description: Informations sur le modèle de serveur créé.
errors:
- uri: servermodel.create.error.database_not_available
- uri: servermodel.create.error.duplicate_servermodel
- uri: servermodel.create.error.invalid_parentservermodel_id
- uri: servermodel.create.error.invalid_source_id
- uri: servermodel.create.error.unknown_parentservermodel_id
- uri: servermodel.create.error.unknown_source_id
- uri: servermodel.create.error.servermodelname_not_provided
related:
- servermodel.list
- servermodel.describe
- servermodel.update
- servermodel.delete
- servermodel.event

View File

@ -0,0 +1,15 @@
---
uri: servermodel.created
description: Des modèles de serveur ont été créés.
pattern: event
public: false
domain: servermodel-domain
parameters:
servermodels:
type: '[]Servermodel'
description: Informations sur les modèles de serveur créés.

View File

@ -0,0 +1,19 @@
---
uri: servermodel.describe.error.database_not_available
sampleuse: ~
public: true
pattern: error
description: |
Erreur retournée lorsque la base de données n'est pas disponible.
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur.
domain: servermodel-domain

View File

@ -0,0 +1,19 @@
---
uri: servermodel.describe.error.invalid_servermodel_id
sampleuse: ~
public: true
pattern: error
description: |
L'argument ServerModelID fourni n'est pas du type Integer.
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur.
domain: servermodel-domain

View File

@ -0,0 +1,19 @@
---
uri: servermodel.describe.error.unknown_servermodel_id
sampleuse: ~
public: true
pattern: error
description: |
L'identifiant ServerModelID ne correspond a aucun enregistrement dans la base.
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur.
domain: servermodel-domain

View File

@ -0,0 +1,67 @@
---
uri: servermodel.describe
description: |
Retourne les attributs détaillés d'un modèle de serveur.
sampleuse: |
zephir-client servermodel.describe -s 1
pattern: rpc
public: true
domain: servermodel-domain
parameters:
servermodelid:
type: Number
shortarg: s
description: Identifiant du modèle de serveur à récupérer.
ref: Servermodel.ServermodelId
inheritance:
type: Boolean
shortarg: i
description: Inclure les données héritées des modèles de serveur parents.
default: true
resolvdepends:
type: Boolean
shortarg: r
description: Résoudre les dépendances de services.
default: true
schema:
type: Boolean
shortarg: c
description: Inclure le schema de configuration (réaggrège les données provenant du datasource).
default: false
probes:
type: Boolean
shortarg: p
description: Inclure les informations sur les sondes de la configuration.
default: false
creolefuncs:
type: Boolean
shortarg: o
description: Inclure les fonctions Creole.
default: false
conffiles:
type: Boolean
shortarg: f
description: Inclure les fichier creole au format tar encodé en base64
default: false
response:
type: Servermodel
description: Description du modèle de serveur.
errors:
- uri: servermodel.describe.error.database_not_available
- uri: servermodel.describe.error.invalid_servermodel_id
- uri: servermodel.describe.error.unknown_servermodel_id
related:
- servermodel.list
- servermodel.create
- servermodel.update
- servermodel.delete
- servermodel.event

View File

@ -0,0 +1,45 @@
---
uri: servermodel.event
sampleuse: ~
description: |
Notifie l'ajout/suppression/modification/liste/description d'un modèle de serveur.
pattern: event
parameters:
method:
type: String
description: |
Méthode utilisée parmi : list / describe / create / update / delete.
parameters:
type: Dict
description: |
list => non requis
describe => servermodelid: Integer
create => servermodelparentsid: Integer
servermodelname: String
sourceid: Integer
update => servermodelid: Integer
servermodelname: String
delete => servermodelid: Integer
result:
type: String
description: |
list => non requis
describe => non requis
create => Integer
update => String
delete => String
public: false
domain: server-domain
related:
- servermodel.list
- servermodel.describe
- servermodel.create
- servermodel.update
- servermodel.delete

View File

@ -0,0 +1,19 @@
---
uri: servermodel.list.error.database_not_available
sampleuse: ~
public: true
pattern: error
description: |
Erreur retournée lorsque la base de données n'est pas disponible.
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur.
domain: servermodel-domain

View File

@ -0,0 +1,36 @@
---
uri: servermodel.list
description: |
Retourne la liste des modèles de serveur disponibles.
sampleuse: |
zephir-client servermodel.list
pattern: rpc
public: true
domain: servermodel-domain
parameters:
sourceid:
type: Number
shortarg: s
description: |
Identifiant de la source à lister.
default: null
response:
type: '[]Servermodel'
description: Liste des modèles de serveur disponibles.
errors:
- uri: servermodel.list.error.database_not_available
related:
- servermodel.describe
- servermodel.create
- servermodel.update
- servermodel.delete
- servermodel.event

View File

@ -0,0 +1,18 @@
---
uri: servermodel.source.list
description: |
Retourne la liste des sources.
sampleuse: |
zephir-client servermodel.source.list
pattern: rpc
public: true
domain: servermodel-domain
response:
type: '[]Dict'
description: Liste des sources disponibles.

View File

@ -0,0 +1,18 @@
---
uri: servermodel.subrelease.list
description: |
Retourne la liste des subreleases.
sampleuse: |
zephir-client servermodel.subrelease.list
pattern: rpc
public: true
domain: servermodel-domain
response:
type: '[]Dict'
description: Liste des sous-releases disponibles.

View File

@ -0,0 +1,15 @@
---
uri: servermodel.updated
description: Des modèles de serveur ont été modifiés.
pattern: event
public: false
domain: servermodel-domain
parameters:
servermodels:
type: '[]Servermodel'
description: Informations sur les modèles de serveur modifiés.

View File

@ -0,0 +1,19 @@
---
uri: serverselection.create.error.duplicate_serverselection
sampleuse: ~
public: true
pattern: error
description: |
Le nom de la Sélection de serveurs existe déjà.
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur.
domain: serverselection-domain

View File

@ -0,0 +1,39 @@
---
uri: serverselection.create
description: |
Crée un sélection de serveurs.
sampleuse: |
zephir-client serverselection.create -n Select1 -d "Ma description"
pattern: rpc
public: true
domain: serverselection-domain
parameters:
serverselectionname:
type: String
shortarg: n
ref: ServerSelection.ServerSelectionName
description: |
Nom de la sélection de serveurs.
serverselectiondescription:
type: String
shortarg: d
description: |
Description de la sélection de serveurs.
response:
type: ServerSelection
description: Description de la sélection créée.
errors:
- uri: serverselection.error.database_not_available
- uri: serverselection.create.error.duplicate_serverselection
related:
- serverselection.describe
- serverselection.delete
- serverselection.list

Some files were not shown because too many files have changed in this diff Show More