commit 37499daccf21d0339df4b7d1e9391bb6fb0fbe3b Author: Emmanuel Garette Date: Thu Nov 28 14:50:53 2019 +0100 first commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5c16bd4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +# Backup and swap files +*~ +*# +*.swp +*.pyc +__pycache__ diff --git a/messages/v1/messages/config.configuration.server.deploy.yml b/messages/v1/messages/config.configuration.server.deploy.yml new file mode 100644 index 0000000..81e7b78 --- /dev/null +++ b/messages/v1/messages/config.configuration.server.deploy.yml @@ -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. diff --git a/messages/v1/messages/config.configuration.server.get.yml b/messages/v1/messages/config.configuration.server.get.yml new file mode 100644 index 0000000..a0eaf36 --- /dev/null +++ b/messages/v1/messages/config.configuration.server.get.yml @@ -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. diff --git a/messages/v1/messages/config.session.server.start.yml b/messages/v1/messages/config.session.server.start.yml new file mode 100644 index 0000000..da585a0 --- /dev/null +++ b/messages/v1/messages/config.session.server.start.yml @@ -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. diff --git a/messages/v1/messages/config.session.server.stop.yml b/messages/v1/messages/config.session.server.stop.yml new file mode 100644 index 0000000..48c85e9 --- /dev/null +++ b/messages/v1/messages/config.session.server.stop.yml @@ -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. diff --git a/messages/v1/messages/old/config.configuration.server.updated.yml b/messages/v1/messages/old/config.configuration.server.updated.yml new file mode 100644 index 0000000..66f3952 --- /dev/null +++ b/messages/v1/messages/old/config.configuration.server.updated.yml @@ -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. diff --git a/messages/v1/messages/old/config.session.error.locked.yml b/messages/v1/messages/old/config.session.error.locked.yml new file mode 100644 index 0000000..dc8840d --- /dev/null +++ b/messages/v1/messages/old/config.session.error.locked.yml @@ -0,0 +1,25 @@ +--- +uri: config.session.error.locked + +sampleuse: ~ + +description: | + Une erreur est survenue lors de la tentative d’ouverture d’une session existante. + +public: true + +pattern: error + +parameters: + reason: + type: String + description: Message de l’erreur lisible par un humain. + sessionid: + type: String + description: Identifiant de la session existante. + ref: Config.SessionId + username: + type: String + description: Nom de l’utilisateur propriétaire de la session existante. + +domain: config-domain diff --git a/messages/v1/messages/old/config.session.server.configure.yml b/messages/v1/messages/old/config.session.server.configure.yml new file mode 100644 index 0000000..77ccbcb --- /dev/null +++ b/messages/v1/messages/old/config.session.server.configure.yml @@ -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. diff --git a/messages/v1/messages/old/config.session.server.filter.yml b/messages/v1/messages/old/config.session.server.filter.yml new file mode 100644 index 0000000..e2c4530 --- /dev/null +++ b/messages/v1/messages/old/config.session.server.filter.yml @@ -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. diff --git a/messages/v1/messages/old/config.session.server.get.yml b/messages/v1/messages/old/config.session.server.get.yml new file mode 100644 index 0000000..a91b1f9 --- /dev/null +++ b/messages/v1/messages/old/config.session.server.get.yml @@ -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. diff --git a/messages/v1/messages/old/config.session.server.list.yml b/messages/v1/messages/old/config.session.server.list.yml new file mode 100644 index 0000000..3e9877c --- /dev/null +++ b/messages/v1/messages/old/config.session.server.list.yml @@ -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. diff --git a/messages/v1/messages/old/config.session.server.validate.yml b/messages/v1/messages/old/config.session.server.validate.yml new file mode 100644 index 0000000..9112336 --- /dev/null +++ b/messages/v1/messages/old/config.session.server.validate.yml @@ -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. + diff --git a/messages/v1/messages/old/config.session.servermodel.configure.yml b/messages/v1/messages/old/config.session.servermodel.configure.yml new file mode 100644 index 0000000..b87d703 --- /dev/null +++ b/messages/v1/messages/old/config.session.servermodel.configure.yml @@ -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. diff --git a/messages/v1/messages/old/config.session.servermodel.filter.yml b/messages/v1/messages/old/config.session.servermodel.filter.yml new file mode 100644 index 0000000..e1cbd73 --- /dev/null +++ b/messages/v1/messages/old/config.session.servermodel.filter.yml @@ -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. diff --git a/messages/v1/messages/old/config.session.servermodel.get.yml b/messages/v1/messages/old/config.session.servermodel.get.yml new file mode 100644 index 0000000..21287c8 --- /dev/null +++ b/messages/v1/messages/old/config.session.servermodel.get.yml @@ -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. diff --git a/messages/v1/messages/old/config.session.servermodel.list.yml b/messages/v1/messages/old/config.session.servermodel.list.yml new file mode 100644 index 0000000..aa211ea --- /dev/null +++ b/messages/v1/messages/old/config.session.servermodel.list.yml @@ -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. diff --git a/messages/v1/messages/old/config.session.servermodel.start.yml b/messages/v1/messages/old/config.session.servermodel.start.yml new file mode 100644 index 0000000..b54299a --- /dev/null +++ b/messages/v1/messages/old/config.session.servermodel.start.yml @@ -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. diff --git a/messages/v1/messages/old/config.session.servermodel.stop.yml b/messages/v1/messages/old/config.session.servermodel.stop.yml new file mode 100644 index 0000000..79590f3 --- /dev/null +++ b/messages/v1/messages/old/config.session.servermodel.stop.yml @@ -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. diff --git a/messages/v1/messages/old/config.session.servermodel.validate.yml b/messages/v1/messages/old/config.session.servermodel.validate.yml new file mode 100644 index 0000000..a3c237c --- /dev/null +++ b/messages/v1/messages/old/config.session.servermodel.validate.yml @@ -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. + diff --git a/messages/v1/messages/old/datasource.available.yml b/messages/v1/messages/old/datasource.available.yml new file mode 100644 index 0000000..69910a2 --- /dev/null +++ b/messages/v1/messages/old/datasource.available.yml @@ -0,0 +1,19 @@ +--- +uri: datasource.available + +sampleuse: ~ + +description: | + Annonce la disponibilité d’une source de données. + +pattern: event + +public: false + +domain: datasource-domain + +parameters: + datasourceurl: + type: String + description: | + Adresse de la source de données. diff --git a/messages/v1/messages/old/execution.salt.configuration.deploy-scheduled.yml b/messages/v1/messages/old/execution.salt.configuration.deploy-scheduled.yml new file mode 100644 index 0000000..7d548bd --- /dev/null +++ b/messages/v1/messages/old/execution.salt.configuration.deploy-scheduled.yml @@ -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 diff --git a/messages/v1/messages/old/execution.salt.configuration.deploy.yml b/messages/v1/messages/old/execution.salt.configuration.deploy.yml new file mode 100644 index 0000000..32289b0 --- /dev/null +++ b/messages/v1/messages/old/execution.salt.configuration.deploy.yml @@ -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 diff --git a/messages/v1/messages/old/execution.salt.configuration.missing.yml b/messages/v1/messages/old/execution.salt.configuration.missing.yml new file mode 100644 index 0000000..30a4312 --- /dev/null +++ b/messages/v1/messages/old/execution.salt.configuration.missing.yml @@ -0,0 +1,21 @@ +--- +uri: execution.salt.configuration.missing + +sampleuse: ~ + +description: | + La configuration du serveur n’existe pas. + +public: true + +pattern: error + +parameters: + reason: + type: String + description: Message d’erreur lisible par un humain. + +domain: execution-domain + +related: + - execution.salt.configuration.deploy diff --git a/messages/v1/messages/old/execution.salt.environment.get.yml b/messages/v1/messages/old/execution.salt.environment.get.yml new file mode 100644 index 0000000..a57cd44 --- /dev/null +++ b/messages/v1/messages/old/execution.salt.environment.get.yml @@ -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. diff --git a/messages/v1/messages/old/execution.salt.exec.command-executed.yml b/messages/v1/messages/old/execution.salt.exec.command-executed.yml new file mode 100644 index 0000000..5830701 --- /dev/null +++ b/messages/v1/messages/old/execution.salt.exec.command-executed.yml @@ -0,0 +1,22 @@ +--- +uri: execution.salt.exec.command-executed + +sampleuse: ~ + +description: | + L’exécution d’une 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 diff --git a/messages/v1/messages/old/execution.salt.exec.error.execute.yml b/messages/v1/messages/old/execution.salt.exec.error.execute.yml new file mode 100644 index 0000000..8a0484c --- /dev/null +++ b/messages/v1/messages/old/execution.salt.exec.error.execute.yml @@ -0,0 +1,21 @@ +--- +uri: execution.salt.exec.error.execute + +sampleuse: ~ + +description: | + Une demande d’exécution a retourné un code d’erreur. + +public: true + +pattern: error + +parameters: + reason: + type: String + description: Message de l’erreur lisible par un humain. + +domain: execution-domain + +related: + - execution.salt.exec diff --git a/messages/v1/messages/old/execution.salt.exec.error.login.yml b/messages/v1/messages/old/execution.salt.exec.error.login.yml new file mode 100644 index 0000000..4c06932 --- /dev/null +++ b/messages/v1/messages/old/execution.salt.exec.error.login.yml @@ -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 l’erreur lisible par un humain. + +domain: execution-domain + +related: + - execution.salt.exec diff --git a/messages/v1/messages/old/execution.salt.exec.error.missing-command.yml b/messages/v1/messages/old/execution.salt.exec.error.missing-command.yml new file mode 100644 index 0000000..61f680e --- /dev/null +++ b/messages/v1/messages/old/execution.salt.exec.error.missing-command.yml @@ -0,0 +1,21 @@ +--- +uri: execution.salt.exec.error.missing-command + +sampleuse: ~ + +description: | + L’argument « Command » n'a pas été fourni. + +public: true + +pattern: error + +parameters: + reason: + type: String + description: Message de l’erreur lisible par un humain. + +domain: execution-domain + +related: + - execution.salt.exec diff --git a/messages/v1/messages/old/execution.salt.exec.error.missing-minion_pattern.yml b/messages/v1/messages/old/execution.salt.exec.error.missing-minion_pattern.yml new file mode 100644 index 0000000..9b20fe8 --- /dev/null +++ b/messages/v1/messages/old/execution.salt.exec.error.missing-minion_pattern.yml @@ -0,0 +1,21 @@ +--- +uri: execution.salt.exec.error.missing-minion_pattern + +sampleuse: ~ + +description: | + L’argument « MinionPattern » n'a pas été fourni. + +public: true + +pattern: error + +parameters: + reason: + type: String + description: Message d’erreur lisible par un humain. + +domain: execution-domain + +related: + - execution.salt.exec diff --git a/messages/v1/messages/old/execution.salt.exec.yml b/messages/v1/messages/old/execution.salt.exec.yml new file mode 100644 index 0000000..4b9de93 --- /dev/null +++ b/messages/v1/messages/old/execution.salt.exec.yml @@ -0,0 +1,65 @@ +--- +uri: execution.salt.exec + +description: | + Planifie l’exécution d’une 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 d’exé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 diff --git a/messages/v1/messages/old/execution.salt.job.describe.yml b/messages/v1/messages/old/execution.salt.job.describe.yml new file mode 100644 index 0000000..466c496 --- /dev/null +++ b/messages/v1/messages/old/execution.salt.job.describe.yml @@ -0,0 +1,33 @@ +--- +uri: execution.salt.job.describe + +description: | + Retourne les attributs détaillés d’une 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 diff --git a/messages/v1/messages/old/execution.salt.job.error.db-connection.yml b/messages/v1/messages/old/execution.salt.job.error.db-connection.yml new file mode 100644 index 0000000..7794f86 --- /dev/null +++ b/messages/v1/messages/old/execution.salt.job.error.db-connection.yml @@ -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 d’erreur lisible par un humain. + +domain: execution-domain + +related: + - execution.salt.job.list + - execution.salt.job.describe diff --git a/messages/v1/messages/old/execution.salt.job.error.jid-type.yml b/messages/v1/messages/old/execution.salt.job.error.jid-type.yml new file mode 100644 index 0000000..1d67f7b --- /dev/null +++ b/messages/v1/messages/old/execution.salt.job.error.jid-type.yml @@ -0,0 +1,21 @@ +--- +uri: execution.salt.job.error.jid-type + +sampleuse: ~ + +description: | + Mauvais type fourni pour l’argument « JID ». + +public: true + +pattern: error + +parameters: + reason: + type: String + description: Message d’erreur lisible par un humain. + +domain: execution-domain + +related: + - execution.salt.job.describe diff --git a/messages/v1/messages/old/execution.salt.job.error.list.yml b/messages/v1/messages/old/execution.salt.job.error.list.yml new file mode 100644 index 0000000..82775fa --- /dev/null +++ b/messages/v1/messages/old/execution.salt.job.error.list.yml @@ -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 d’erreur lisible par un humain. + +domain: execution-domain + +related: + - execution.salt.job.list diff --git a/messages/v1/messages/old/execution.salt.job.error.missing-jid.yml b/messages/v1/messages/old/execution.salt.job.error.missing-jid.yml new file mode 100644 index 0000000..7b91f1d --- /dev/null +++ b/messages/v1/messages/old/execution.salt.job.error.missing-jid.yml @@ -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 d’erreur lisible par un humain. + +domain: execution-domain + +related: + - execution.salt.job.describe diff --git a/messages/v1/messages/old/execution.salt.job.error.unknown-jid.yml b/messages/v1/messages/old/execution.salt.job.error.unknown-jid.yml new file mode 100644 index 0000000..920d34a --- /dev/null +++ b/messages/v1/messages/old/execution.salt.job.error.unknown-jid.yml @@ -0,0 +1,21 @@ +--- +uri: execution.salt.job.error.unknown-jid + +sampleuse: ~ + +description: | + L’identifiant de tâche est inconnu de SalStack. + +public: true + +pattern: error + +parameters: + reason: + type: String + description: Message d’erreur lisible par un humain. + +domain: execution-domain + +related: + - execution.salt.job.describe diff --git a/messages/v1/messages/old/execution.salt.job.list.yml b/messages/v1/messages/old/execution.salt.job.list.yml new file mode 100644 index 0000000..084f3ca --- /dev/null +++ b/messages/v1/messages/old/execution.salt.job.list.yml @@ -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 diff --git a/messages/v1/messages/old/execution.salt.master.event.ready.yml b/messages/v1/messages/old/execution.salt.master.event.ready.yml new file mode 100644 index 0000000..c65ddec --- /dev/null +++ b/messages/v1/messages/old/execution.salt.master.event.ready.yml @@ -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. diff --git a/messages/v1/messages/old/execution.salt.master.event.start.yml b/messages/v1/messages/old/execution.salt.master.event.start.yml new file mode 100644 index 0000000..715eed4 --- /dev/null +++ b/messages/v1/messages/old/execution.salt.master.event.start.yml @@ -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. diff --git a/messages/v1/messages/old/execution.salt.minion.registered.yml b/messages/v1/messages/old/execution.salt.minion.registered.yml new file mode 100644 index 0000000..78cbd0c --- /dev/null +++ b/messages/v1/messages/old/execution.salt.minion.registered.yml @@ -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. diff --git a/messages/v1/messages/old/execution.salt.minion.unregistered.yml b/messages/v1/messages/old/execution.salt.minion.unregistered.yml new file mode 100644 index 0000000..c36c999 --- /dev/null +++ b/messages/v1/messages/old/execution.salt.minion.unregistered.yml @@ -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. diff --git a/messages/v1/messages/old/execution.salt.peer.error.yml b/messages/v1/messages/old/execution.salt.peer.error.yml new file mode 100644 index 0000000..df8bd1b --- /dev/null +++ b/messages/v1/messages/old/execution.salt.peer.error.yml @@ -0,0 +1,21 @@ +--- +uri: execution.salt.peer.error + +sampleuse: ~ + +description: | + Un appairage Saltstack s’est terminé avec un code d’erreur. + +public: true + +pattern: error + +parameters: + reason: + type: String + description: Message d’erreur lisible par un humain. + +domain: server-domain + +related: + - execution.salt.peer diff --git a/messages/v1/messages/old/execution.salt.peer.registered.yml b/messages/v1/messages/old/execution.salt.peer.registered.yml new file mode 100644 index 0000000..c6d07b4 --- /dev/null +++ b/messages/v1/messages/old/execution.salt.peer.registered.yml @@ -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 diff --git a/messages/v1/messages/old/identity.session-user.get.yml b/messages/v1/messages/old/identity.session-user.get.yml new file mode 100644 index 0000000..86d0f8e --- /dev/null +++ b/messages/v1/messages/old/identity.session-user.get.yml @@ -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. diff --git a/messages/v1/messages/old/identity.settings.get.yml b/messages/v1/messages/old/identity.settings.get.yml new file mode 100644 index 0000000..85942f6 --- /dev/null +++ b/messages/v1/messages/old/identity.settings.get.yml @@ -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. diff --git a/messages/v1/messages/old/identity.settings.set.yml b/messages/v1/messages/old/identity.settings.set.yml new file mode 100644 index 0000000..6b35a1e --- /dev/null +++ b/messages/v1/messages/old/identity.settings.set.yml @@ -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. diff --git a/messages/v1/messages/old/identity.settings.updated.yml b/messages/v1/messages/old/identity.settings.updated.yml new file mode 100644 index 0000000..ccc5dbd --- /dev/null +++ b/messages/v1/messages/old/identity.settings.updated.yml @@ -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. diff --git a/messages/v1/messages/old/server.configuration.updated.yml b/messages/v1/messages/old/server.configuration.updated.yml new file mode 100644 index 0000000..939a648 --- /dev/null +++ b/messages/v1/messages/old/server.configuration.updated.yml @@ -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. diff --git a/messages/v1/messages/old/server.create.yml b/messages/v1/messages/old/server.create.yml new file mode 100644 index 0000000..6653c56 --- /dev/null +++ b/messages/v1/messages/old/server.create.yml @@ -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 diff --git a/messages/v1/messages/old/server.created.yml b/messages/v1/messages/old/server.created.yml new file mode 100644 index 0000000..e5477bf --- /dev/null +++ b/messages/v1/messages/old/server.created.yml @@ -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. diff --git a/messages/v1/messages/old/server.delete.yml b/messages/v1/messages/old/server.delete.yml new file mode 100644 index 0000000..747eb8c --- /dev/null +++ b/messages/v1/messages/old/server.delete.yml @@ -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 diff --git a/messages/v1/messages/old/server.deleted.yml b/messages/v1/messages/old/server.deleted.yml new file mode 100644 index 0000000..09d0f92 --- /dev/null +++ b/messages/v1/messages/old/server.deleted.yml @@ -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é. diff --git a/messages/v1/messages/old/server.describe.yml b/messages/v1/messages/old/server.describe.yml new file mode 100644 index 0000000..b976339 --- /dev/null +++ b/messages/v1/messages/old/server.describe.yml @@ -0,0 +1,49 @@ +--- +uri: server.describe + +description: | + Retourne les attributs détaillés d’un 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 diff --git a/messages/v1/messages/old/server.environment.updated.yml b/messages/v1/messages/old/server.environment.updated.yml new file mode 100644 index 0000000..97a835e --- /dev/null +++ b/messages/v1/messages/old/server.environment.updated.yml @@ -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. diff --git a/messages/v1/messages/old/server.error.database-not-available.yml b/messages/v1/messages/old/server.error.database-not-available.yml new file mode 100644 index 0000000..0cf790a --- /dev/null +++ b/messages/v1/messages/old/server.error.database-not-available.yml @@ -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 l’erreur lisible par un humain. + +domain: server-domain + +related: + - server.list + - server.describe + - server.create + - server.update + - server.delete diff --git a/messages/v1/messages/old/server.error.db-connection.yml b/messages/v1/messages/old/server.error.db-connection.yml new file mode 100644 index 0000000..0b20261 --- /dev/null +++ b/messages/v1/messages/old/server.error.db-connection.yml @@ -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 l’erreur lisible par un humain. + +domain: server-domain + +related: + - server.list + - server.describe + - server.create + - server.update + - server.delete diff --git a/messages/v1/messages/old/server.error.invalid-server-id.yml b/messages/v1/messages/old/server.error.invalid-server-id.yml new file mode 100644 index 0000000..ec336d7 --- /dev/null +++ b/messages/v1/messages/old/server.error.invalid-server-id.yml @@ -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 l’erreur lisible par un humain. + +domain: server-domain + +related: + - server.describe + - server.update + - server.delete diff --git a/messages/v1/messages/old/server.error.invalid-servermodel-id.yml b/messages/v1/messages/old/server.error.invalid-servermodel-id.yml new file mode 100644 index 0000000..cab60fe --- /dev/null +++ b/messages/v1/messages/old/server.error.invalid-servermodel-id.yml @@ -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 l’erreur lisible par un humain. + +domain: server-domain + +related: + - server.create diff --git a/messages/v1/messages/old/server.error.peering-conf-not-available.yml b/messages/v1/messages/old/server.error.peering-conf-not-available.yml new file mode 100644 index 0000000..d24f803 --- /dev/null +++ b/messages/v1/messages/old/server.error.peering-conf-not-available.yml @@ -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 l’erreur lisible par un humain. + +domain: server-domain + +related: + - server.get-peering-conf diff --git a/messages/v1/messages/old/server.error.servername-not-provided.yml b/messages/v1/messages/old/server.error.servername-not-provided.yml new file mode 100644 index 0000000..dddbf12 --- /dev/null +++ b/messages/v1/messages/old/server.error.servername-not-provided.yml @@ -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 l’erreur lisible par un humain. + +domain: server-domain + +related: + - server.create + - server.update diff --git a/messages/v1/messages/old/server.error.unknown-server-id.yml b/messages/v1/messages/old/server.error.unknown-server-id.yml new file mode 100644 index 0000000..5778359 --- /dev/null +++ b/messages/v1/messages/old/server.error.unknown-server-id.yml @@ -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 l’erreur lisible par un humain. + +domain: server-domain + +related: + - server.describe + - server.update + - server.delete diff --git a/messages/v1/messages/old/server.error.unknown-servermodel-id.yml b/messages/v1/messages/old/server.error.unknown-servermodel-id.yml new file mode 100644 index 0000000..77931a1 --- /dev/null +++ b/messages/v1/messages/old/server.error.unknown-servermodel-id.yml @@ -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 l’erreur lisible par un humain. + +domain: server-domain + +related: + - server.create diff --git a/messages/v1/messages/old/server.error.yml b/messages/v1/messages/old/server.error.yml new file mode 100644 index 0000000..a1aeb21 --- /dev/null +++ b/messages/v1/messages/old/server.error.yml @@ -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 l’erreur lisible par un humain. + +domain: server-domain + +related: + - server.list + - server.describe + - server.create + - server.update + - server.delete diff --git a/messages/v1/messages/old/server.exec.command.yml b/messages/v1/messages/old/server.exec.command.yml new file mode 100644 index 0000000..56a05ea --- /dev/null +++ b/messages/v1/messages/old/server.exec.command.yml @@ -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 diff --git a/messages/v1/messages/old/server.exec.deploy.yml b/messages/v1/messages/old/server.exec.deploy.yml new file mode 100644 index 0000000..e78b684 --- /dev/null +++ b/messages/v1/messages/old/server.exec.deploy.yml @@ -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. diff --git a/messages/v1/messages/old/server.exec.describe.yml b/messages/v1/messages/old/server.exec.describe.yml new file mode 100644 index 0000000..343ba60 --- /dev/null +++ b/messages/v1/messages/old/server.exec.describe.yml @@ -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. + diff --git a/messages/v1/messages/old/server.exec.error.missing-command.yml b/messages/v1/messages/old/server.exec.error.missing-command.yml new file mode 100644 index 0000000..8b928e1 --- /dev/null +++ b/messages/v1/messages/old/server.exec.error.missing-command.yml @@ -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 l’erreur lisible par un humain. + +domain: server-domain + +related: + - server.exec diff --git a/messages/v1/messages/old/server.exec.error.unmanaged-server.yml b/messages/v1/messages/old/server.exec.error.unmanaged-server.yml new file mode 100644 index 0000000..ae3888c --- /dev/null +++ b/messages/v1/messages/old/server.exec.error.unmanaged-server.yml @@ -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 l’erreur lisible par un humain. + +domain: server-domain + +related: + - server.exec diff --git a/messages/v1/messages/old/server.exec.list.yml b/messages/v1/messages/old/server.exec.list.yml new file mode 100644 index 0000000..6356ef6 --- /dev/null +++ b/messages/v1/messages/old/server.exec.list.yml @@ -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. diff --git a/messages/v1/messages/old/server.executed.yml b/messages/v1/messages/old/server.executed.yml new file mode 100644 index 0000000..5404e6e --- /dev/null +++ b/messages/v1/messages/old/server.executed.yml @@ -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. diff --git a/messages/v1/messages/old/server.list.yml b/messages/v1/messages/old/server.list.yml new file mode 100644 index 0000000..9c5fa82 --- /dev/null +++ b/messages/v1/messages/old/server.list.yml @@ -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. diff --git a/messages/v1/messages/old/server.peer-connection.update.yml b/messages/v1/messages/old/server.peer-connection.update.yml new file mode 100644 index 0000000..1d8daa5 --- /dev/null +++ b/messages/v1/messages/old/server.peer-connection.update.yml @@ -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 diff --git a/messages/v1/messages/old/server.salt.registered.yml b/messages/v1/messages/old/server.salt.registered.yml new file mode 100644 index 0000000..e314f19 --- /dev/null +++ b/messages/v1/messages/old/server.salt.registered.yml @@ -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 diff --git a/messages/v1/messages/old/server.serverselection.list.yml b/messages/v1/messages/old/server.serverselection.list.yml new file mode 100644 index 0000000..81ece80 --- /dev/null +++ b/messages/v1/messages/old/server.serverselection.list.yml @@ -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 diff --git a/messages/v1/messages/old/server.storage.event.yml b/messages/v1/messages/old/server.storage.event.yml new file mode 100644 index 0000000..d7ccbe4 --- /dev/null +++ b/messages/v1/messages/old/server.storage.event.yml @@ -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é (/). + event_type: + type: String + description: Type d'évènement remonté (s3:ObjectCreated:Put, s3:ObjectRemoved:Delete). + +public: false + +domain: server-domain diff --git a/messages/v1/messages/old/server.update.yml b/messages/v1/messages/old/server.update.yml new file mode 100644 index 0000000..cc36169 --- /dev/null +++ b/messages/v1/messages/old/server.update.yml @@ -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 diff --git a/messages/v1/messages/old/server.updated.yml b/messages/v1/messages/old/server.updated.yml new file mode 100644 index 0000000..a629bc0 --- /dev/null +++ b/messages/v1/messages/old/server.updated.yml @@ -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. diff --git a/messages/v1/messages/old/servermodel.applicationservice.join.yml b/messages/v1/messages/old/servermodel.applicationservice.join.yml new file mode 100644 index 0000000..5458a8f --- /dev/null +++ b/messages/v1/messages/old/servermodel.applicationservice.join.yml @@ -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. + diff --git a/messages/v1/messages/old/servermodel.applicationservice.list.yml b/messages/v1/messages/old/servermodel.applicationservice.list.yml new file mode 100644 index 0000000..bcd9ba0 --- /dev/null +++ b/messages/v1/messages/old/servermodel.applicationservice.list.yml @@ -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. diff --git a/messages/v1/messages/old/servermodel.create.error.database_not_available.yml b/messages/v1/messages/old/servermodel.create.error.database_not_available.yml new file mode 100644 index 0000000..be849db --- /dev/null +++ b/messages/v1/messages/old/servermodel.create.error.database_not_available.yml @@ -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 diff --git a/messages/v1/messages/old/servermodel.create.error.duplicate_servermodel.yml b/messages/v1/messages/old/servermodel.create.error.duplicate_servermodel.yml new file mode 100644 index 0000000..b88107d --- /dev/null +++ b/messages/v1/messages/old/servermodel.create.error.duplicate_servermodel.yml @@ -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 diff --git a/messages/v1/messages/old/servermodel.create.error.invalid_parentservermodel_id.yml b/messages/v1/messages/old/servermodel.create.error.invalid_parentservermodel_id.yml new file mode 100644 index 0000000..97b0e5c --- /dev/null +++ b/messages/v1/messages/old/servermodel.create.error.invalid_parentservermodel_id.yml @@ -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 diff --git a/messages/v1/messages/old/servermodel.create.error.invalid_source_id.yml b/messages/v1/messages/old/servermodel.create.error.invalid_source_id.yml new file mode 100644 index 0000000..3890be6 --- /dev/null +++ b/messages/v1/messages/old/servermodel.create.error.invalid_source_id.yml @@ -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 diff --git a/messages/v1/messages/old/servermodel.create.error.servermodelname_not_provided.yml b/messages/v1/messages/old/servermodel.create.error.servermodelname_not_provided.yml new file mode 100644 index 0000000..0db930a --- /dev/null +++ b/messages/v1/messages/old/servermodel.create.error.servermodelname_not_provided.yml @@ -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 diff --git a/messages/v1/messages/old/servermodel.create.error.unknown_parentservermodel_id.yml b/messages/v1/messages/old/servermodel.create.error.unknown_parentservermodel_id.yml new file mode 100644 index 0000000..2c2ec49 --- /dev/null +++ b/messages/v1/messages/old/servermodel.create.error.unknown_parentservermodel_id.yml @@ -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 diff --git a/messages/v1/messages/old/servermodel.create.error.unknown_source_id.yml b/messages/v1/messages/old/servermodel.create.error.unknown_source_id.yml new file mode 100644 index 0000000..cb36b58 --- /dev/null +++ b/messages/v1/messages/old/servermodel.create.error.unknown_source_id.yml @@ -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 diff --git a/messages/v1/messages/old/servermodel.create.yml b/messages/v1/messages/old/servermodel.create.yml new file mode 100644 index 0000000..63d48b5 --- /dev/null +++ b/messages/v1/messages/old/servermodel.create.yml @@ -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 diff --git a/messages/v1/messages/old/servermodel.created.yml b/messages/v1/messages/old/servermodel.created.yml new file mode 100644 index 0000000..e180b78 --- /dev/null +++ b/messages/v1/messages/old/servermodel.created.yml @@ -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. diff --git a/messages/v1/messages/old/servermodel.describe.error.database_not_available.yml b/messages/v1/messages/old/servermodel.describe.error.database_not_available.yml new file mode 100644 index 0000000..cc37053 --- /dev/null +++ b/messages/v1/messages/old/servermodel.describe.error.database_not_available.yml @@ -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 diff --git a/messages/v1/messages/old/servermodel.describe.error.invalid_servermodel_id.yml b/messages/v1/messages/old/servermodel.describe.error.invalid_servermodel_id.yml new file mode 100644 index 0000000..231f0b5 --- /dev/null +++ b/messages/v1/messages/old/servermodel.describe.error.invalid_servermodel_id.yml @@ -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 diff --git a/messages/v1/messages/old/servermodel.describe.error.unknown_servermodel_id.yml b/messages/v1/messages/old/servermodel.describe.error.unknown_servermodel_id.yml new file mode 100644 index 0000000..bae0c9a --- /dev/null +++ b/messages/v1/messages/old/servermodel.describe.error.unknown_servermodel_id.yml @@ -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 diff --git a/messages/v1/messages/old/servermodel.describe.yml b/messages/v1/messages/old/servermodel.describe.yml new file mode 100644 index 0000000..6e82436 --- /dev/null +++ b/messages/v1/messages/old/servermodel.describe.yml @@ -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 diff --git a/messages/v1/messages/old/servermodel.event.yml b/messages/v1/messages/old/servermodel.event.yml new file mode 100644 index 0000000..f54bddf --- /dev/null +++ b/messages/v1/messages/old/servermodel.event.yml @@ -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 diff --git a/messages/v1/messages/old/servermodel.list.error.database_not_available.yml b/messages/v1/messages/old/servermodel.list.error.database_not_available.yml new file mode 100644 index 0000000..80e8f3c --- /dev/null +++ b/messages/v1/messages/old/servermodel.list.error.database_not_available.yml @@ -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 diff --git a/messages/v1/messages/old/servermodel.list.yml b/messages/v1/messages/old/servermodel.list.yml new file mode 100644 index 0000000..6e0964c --- /dev/null +++ b/messages/v1/messages/old/servermodel.list.yml @@ -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 diff --git a/messages/v1/messages/old/servermodel.source.list.yml b/messages/v1/messages/old/servermodel.source.list.yml new file mode 100644 index 0000000..86f753c --- /dev/null +++ b/messages/v1/messages/old/servermodel.source.list.yml @@ -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. diff --git a/messages/v1/messages/old/servermodel.subrelease.list.yml b/messages/v1/messages/old/servermodel.subrelease.list.yml new file mode 100644 index 0000000..4d0bb1f --- /dev/null +++ b/messages/v1/messages/old/servermodel.subrelease.list.yml @@ -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. diff --git a/messages/v1/messages/old/servermodel.updated.yml b/messages/v1/messages/old/servermodel.updated.yml new file mode 100644 index 0000000..46af1fe --- /dev/null +++ b/messages/v1/messages/old/servermodel.updated.yml @@ -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. diff --git a/messages/v1/messages/old/serverselection.create.error.duplicate_serverselection.yml b/messages/v1/messages/old/serverselection.create.error.duplicate_serverselection.yml new file mode 100644 index 0000000..9e05101 --- /dev/null +++ b/messages/v1/messages/old/serverselection.create.error.duplicate_serverselection.yml @@ -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 diff --git a/messages/v1/messages/old/serverselection.create.yml b/messages/v1/messages/old/serverselection.create.yml new file mode 100644 index 0000000..a5e8741 --- /dev/null +++ b/messages/v1/messages/old/serverselection.create.yml @@ -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 diff --git a/messages/v1/messages/old/serverselection.delete.yml b/messages/v1/messages/old/serverselection.delete.yml new file mode 100644 index 0000000..07ead43 --- /dev/null +++ b/messages/v1/messages/old/serverselection.delete.yml @@ -0,0 +1,34 @@ +--- +uri: serverselection.delete + +description: | + Supprime une sélection de serveurs. + +sampleuse: | + zephir-client serverselection.delete -s 1 + +pattern: rpc + +public: true + +domain: serverselection-domain + +parameters: + serverselectionid: + type: Number + shortarg: s + ref: ServerSelection.ServerSelectionId + description: | + Identifiant de la sélection de serveurs. + +response: + type: ServerSelection + description: Description de la sélection supprimée. + +errors: + - uri: serverselection.error.database_not_available + +related: + - serverselection.describe + - serverselection.create + - serverselection.list diff --git a/messages/v1/messages/old/serverselection.describe.yml b/messages/v1/messages/old/serverselection.describe.yml new file mode 100644 index 0000000..e7c3a46 --- /dev/null +++ b/messages/v1/messages/old/serverselection.describe.yml @@ -0,0 +1,35 @@ +--- +uri: serverselection.describe + +description: | + Retourne les attributs détaillés d'une sélection de serveurs. + + +sampleuse: | + zephir-client serverselection.describe -s 1 + +pattern: rpc + +public: true + +domain: serverselection-domain + +parameters: + serverselectionid: + type: Number + shortarg: s + description: | + Identifiant de la sélection de serveurs. + +response: + type: ServerSelection + description: Description de la sélection de serveurs. + +errors: + - uri: serverselection.error.database_not_available + - uri: serverselection.error.invalid_serverselection_id + +related: + - serverselection.delete + - serverselection.create + - serverselection.list diff --git a/messages/v1/messages/old/serverselection.error.database_not_available.yml b/messages/v1/messages/old/serverselection.error.database_not_available.yml new file mode 100644 index 0000000..db1fb27 --- /dev/null +++ b/messages/v1/messages/old/serverselection.error.database_not_available.yml @@ -0,0 +1,19 @@ +--- +uri: serverselection.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: serverselection-domain diff --git a/messages/v1/messages/old/serverselection.error.db-connection.yml b/messages/v1/messages/old/serverselection.error.db-connection.yml new file mode 100644 index 0000000..e219a90 --- /dev/null +++ b/messages/v1/messages/old/serverselection.error.db-connection.yml @@ -0,0 +1,28 @@ +--- +uri: serverselection.error.db-connection + +sampleuse: ~ + +description: | + Erreur de connexion à la base de données. + +public: true + +pattern: error + +parameters: + reason: + type: String + description: | + Description supplémentaire des causes de l'erreur. + +domain: serverselection-domain + +related: + - serverselection.static.list + - serverselection.static.describe + - serverselection.static.create + - serverselection.static.update + - serverselection.static.delete + - serverselection.static.add + - serverselection.static.remove diff --git a/messages/v1/messages/old/serverselection.error.invalid_server_id.yml b/messages/v1/messages/old/serverselection.error.invalid_server_id.yml new file mode 100644 index 0000000..04ee79b --- /dev/null +++ b/messages/v1/messages/old/serverselection.error.invalid_server_id.yml @@ -0,0 +1,19 @@ +--- +uri: serverselection.error.invalid_server_id + +sampleuse: ~ + +public: true + +pattern: error + +description: | + L'argument ServerID fourni n'est pas du type Integer. + +parameters: + reason: + type: String + description: | + Description supplémentaire des causes de l'erreur. + +domain: serverselection-domain diff --git a/messages/v1/messages/old/serverselection.error.invalid_serverselection_id.yml b/messages/v1/messages/old/serverselection.error.invalid_serverselection_id.yml new file mode 100644 index 0000000..83788ea --- /dev/null +++ b/messages/v1/messages/old/serverselection.error.invalid_serverselection_id.yml @@ -0,0 +1,19 @@ +--- +uri: serverselection.error.invalid_serverselection_id + +sampleuse: ~ + +public: true + +pattern: error + +description: | + L'argument ServerSelectionID fourni n'est pas du type Integer. + +parameters: + reason: + type: String + description: | + Description supplémentaire des causes de l'erreur. + +domain: serverselection-domain diff --git a/messages/v1/messages/old/serverselection.error.unknown_server_id.yml b/messages/v1/messages/old/serverselection.error.unknown_server_id.yml new file mode 100644 index 0000000..0ece85f --- /dev/null +++ b/messages/v1/messages/old/serverselection.error.unknown_server_id.yml @@ -0,0 +1,19 @@ +--- +uri: serverselection.error.unknown_server_id + +sampleuse: ~ + +public: true + +pattern: error + +description: | + L'argument ServerID fourni est inconnu. + +parameters: + reason: + type: String + description: | + Description supplémentaire des causes de l'erreur. + +domain: serverselection-domain diff --git a/messages/v1/messages/old/serverselection.error.unkown_serverselection_id.yml b/messages/v1/messages/old/serverselection.error.unkown_serverselection_id.yml new file mode 100644 index 0000000..84fe3ca --- /dev/null +++ b/messages/v1/messages/old/serverselection.error.unkown_serverselection_id.yml @@ -0,0 +1,19 @@ +--- +uri: serverselection.error.unknown_serverselection_id + +sampleuse: ~ + +public: true + +pattern: error + +description: | + L'argument ServerSelectionID est inconnu. + +parameters: + reason: + type: String + description: | + Description supplémentaire des causes de l'erreur. + +domain: serverselection-domain diff --git a/messages/v1/messages/old/serverselection.exec.command.yml b/messages/v1/messages/old/serverselection.exec.command.yml new file mode 100644 index 0000000..3da8f48 --- /dev/null +++ b/messages/v1/messages/old/serverselection.exec.command.yml @@ -0,0 +1,30 @@ +--- +uri: serverselection.exec.command + +description: | + Transmet une commande à exécuter sur une sélection de serveurs. + +sampleuse: | + zephir-client serverselection.exec.command -s 1 -c reconfigure + +domain: server-domain + +pattern: rpc + +public: true + +parameters: + serverselection_id: + type: Number + description: Identifiant de la sélection de serveurs sur laquelle la commande sera exécutée. + shortarg: s + ref: Server.ServerId + command: + type: String + description: Commande à exécuter. + shortarg: c + ref: salt.exec.availablecommands + +response: + type: '[]ServerExec' + description: Liste des jobs de la commande exécutée sur les serveurs de la sélection. diff --git a/messages/v1/messages/old/serverselection.exec.deploy.yml b/messages/v1/messages/old/serverselection.exec.deploy.yml new file mode 100644 index 0000000..bdb66a9 --- /dev/null +++ b/messages/v1/messages/old/serverselection.exec.deploy.yml @@ -0,0 +1,25 @@ +--- +uri: serverselection.exec.deploy + +description: | + Déploie la configuration sur les serveurs d'une sélection de serveurs. + +sampleuse: | + zephir-client serverselection.exec.deploy -s 1 + +domain: server-domain + +pattern: rpc + +public: true + +parameters: + serverselection_id: + type: Number + description: Identifiant de la sélection de serveurs sur laquelle la commande sera exécutée. + shortarg: s + ref: Server.ServerId + +response: + type: '[]ServerExec' + description: Liste des jobs de la commande exécutée sur les serveurs de la sélection. diff --git a/messages/v1/messages/old/serverselection.list.yml b/messages/v1/messages/old/serverselection.list.yml new file mode 100644 index 0000000..f678669 --- /dev/null +++ b/messages/v1/messages/old/serverselection.list.yml @@ -0,0 +1,26 @@ +--- +uri: serverselection.list + +description: | + Retourne la liste des sélections de serveurs. + +sampleuse: | + zephir-client serverselection.list + +pattern: rpc + +public: true + +domain: serverselection-domain + +response: + type: '[]ServerSelection' + description: List des sélections de serveurs de l'utilisateur. + +errors: + - uri: serverselection.error.database_not_available + +related: + - serverselection.describe + - serverselection.create + - serverselection.delete diff --git a/messages/v1/messages/old/serverselection.server.add.yml b/messages/v1/messages/old/serverselection.server.add.yml new file mode 100644 index 0000000..b87d15c --- /dev/null +++ b/messages/v1/messages/old/serverselection.server.add.yml @@ -0,0 +1,42 @@ +--- +uri: serverselection.server.add + +description: | + Ajoute un serveur à une sélection de serveurs. + +sampleuse: | + zephir-client serverselection.add.server -s 1 -i 1 + +pattern: rpc + +public: true + +domain: serverselection-domain + +parameters: + serverselectionid: + type: Number + shortarg: s + ref: ServerSelection.ServerSelectionId + description: | + Identifiant de la sélection de serveurs. + serverid: + type: Number + shortarg: i + ref: ServerSelection.SelectionServers + description: | + Identifiant du serveur à ajouter à la sélection. + +response: + type: ServerSelection + description: Description de la sélection modifiée. + +errors: + - uri: serverselection.error.database_not_available + - uri: serverselection.error.invalid_serverselection_id + - uri: serverselection.error.invalid_server_id + +related: + - serverselection.describe + - serverselection.delete + - serverselection.list diff --git a/messages/v1/messages/old/serverselection.server.remove.yml b/messages/v1/messages/old/serverselection.server.remove.yml new file mode 100644 index 0000000..193bcdb --- /dev/null +++ b/messages/v1/messages/old/serverselection.server.remove.yml @@ -0,0 +1,42 @@ +--- +uri: serverselection.server.remove + +description: | + Supprime un serveur d'une sélection de serveurs. + +sampleuse: | + zephir-client serverselection.remove.server -s 1 -i 1 + +pattern: rpc + +public: true + +domain: serverselection-domain + +parameters: + serverselectionid: + type: Number + shortarg: s + ref: ServerSelection.ServerSelectionId + description: | + Identifiant de la sélection de serveurs. + serverid: + type: Number + shortarg: i + ref: ServerSelection.SelectionServers + description: | + Identifiant du serveur à supprimer de la sélection. + +response: + type: ServerSelection + description: Description de la sélection modifiée. + +errors: + - uri: serverselection.error.database_not_available + - uri: serverselection.error.invalid_serverselection_id + - uri: serverselection.error.invalid_server_id + +related: + - serverselection.delete + - serverselection.create + - serverselection.list diff --git a/messages/v1/messages/old/serverselection.server.set.yml b/messages/v1/messages/old/serverselection.server.set.yml new file mode 100644 index 0000000..4017248 --- /dev/null +++ b/messages/v1/messages/old/serverselection.server.set.yml @@ -0,0 +1,41 @@ +--- +uri: serverselection.server.set + +description: | + Renseigne une liste de serveur dans une sélection de serveurs. + +sampleuse: | + zephir-client serverselection.server.set -s 1 -i 1 + +pattern: rpc + +public: true + +domain: serverselection-domain + +parameters: + serverselectionid: + type: Number + shortarg: s + ref: ServerSelection.ServerSelectionId + description: | + Identifiant de la sélection de serveurs. + serveridlist: + type: String + shortarg: l + description: | + Liste d'identifiants de serveurs sous forme de list x,y,z + +response: + type: ServerSelection + description: Description de la sélection modifiée. + +errors: + - uri: serverselection.error.database_not_available + - uri: serverselection.error.invalid_serverselection_id + - uri: serverselection.error.invalid_server_id + +related: + - serverselection.describe + - serverselection.delete + - serverselection.list diff --git a/messages/v1/messages/old/serverselection.update.yml b/messages/v1/messages/old/serverselection.update.yml new file mode 100644 index 0000000..5f0ae6d --- /dev/null +++ b/messages/v1/messages/old/serverselection.update.yml @@ -0,0 +1,57 @@ +--- +uri: serverselection.update + +description: | + Modifie une sélection de serveur. + +sampleuse: | + zephir-client serverselection.update -s 1 -n Select1 -d "Ma description" + +pattern: rpc + +public: true + +domain: serverselection-domain + +parameters: + serverselectionid: + type: Number + shortarg: s + ref: ServerSelection.ServerSelectionId + description: | + Identifiant de la sélection de serveurs. + serverselectionname: + type: String + shortarg: n + ref: ServerSelection.ServerSelectionName + description: | + Nouveau nom de la sélection de serveurs. + serverselectiondescription: + type: String + shortarg: d + description: | + Nouvelle description de la sélection de serveurs. + dynamique: + type: Boolean + shortarg: y + description: | + Rend la sélection de serveurs dynamique. + default: false + requete: + type: String + shortarg: r + description: | + Nouvelle Requete de la sélection de serveurs. + +response: + type: ServerSelection + description: Description de la sélection modifiée. + +errors: + - uri: serverselection.error.database_not_available + - uri: serverselection.create.error.duplicate_serverselection +related: + - serverselection.describe + - serverselection.delete + - serverselection.list + - serverselection.create diff --git a/messages/v1/messages/old/serverselection.user.add.yml b/messages/v1/messages/old/serverselection.user.add.yml new file mode 100644 index 0000000..fae9390 --- /dev/null +++ b/messages/v1/messages/old/serverselection.user.add.yml @@ -0,0 +1,46 @@ +--- +uri: serverselection.user.add + +description: | + Associe un utilisateur à une sélection de serveurs. + +sampleuse: | + zephir-client serverselection.add.user -s 1 -u yo -r admin + +pattern: rpc + +public: true + +domain: serverselection-domain + +parameters: + serverselectionid: + type: Number + shortarg: s + ref: ServerSelection.ServerSelectionId + description: | + Identifiant de la sélection de serveurs. + username: + type: String + shortarg: u + description: | + Nom de l'utilisateur à associer à la sélection de serveurs. + role: + type: String + shortarg: r + description: | + Rôle de l'utilisateur (root, admin, manager, viewer). + +response: + type: ServerSelection + description: Description de la sélection modifiée. + +errors: + - uri: serverselection.error.database_not_available + - uri: serverselection.error.invalid_serverselection_id + - uri: serverselection.error.invalid_server_id + +related: + - serverselection.delete + - serverselection.create + - serverselection.list diff --git a/messages/v1/messages/old/serverselection.user.default.yml b/messages/v1/messages/old/serverselection.user.default.yml new file mode 100644 index 0000000..25eb339 --- /dev/null +++ b/messages/v1/messages/old/serverselection.user.default.yml @@ -0,0 +1,27 @@ +--- +uri: serverselection.user.default + +description: | + Retourne la sélection de serveurs par défaut de l'utilisateur. + +sampleuse: | + zephir-client serverselection.user.default + +pattern: rpc + +public: false + +domain: serverselection-domain + +response: + type: ServerSelection + description: Sélection de serveurs par défaut de l'utilisateur. + +errors: + - uri: serverselection.error.database_not_available + - uri: serverselection.error.invalid_serverselection_id + +related: + - serverselection.delete + - serverselection.create + - serverselection.list diff --git a/messages/v1/messages/old/serverselection.user.list.yml b/messages/v1/messages/old/serverselection.user.list.yml new file mode 100644 index 0000000..f20fcbc --- /dev/null +++ b/messages/v1/messages/old/serverselection.user.list.yml @@ -0,0 +1,27 @@ +--- +uri: serverselection.user.list + +description: | + Retourne les sélections de serveurs dont l'utilisateur fait parti. + +sampleuse: | + zephir-client serverselection.user.list + +pattern: rpc + +public: true + +domain: serverselection-domain + +response: + type: '[]ServerSelection' + description: Liste des sélections de serveurs de l'utilisateur. + +errors: + - uri: serverselection.error.database_not_available + - uri: serverselection.error.invalid_serverselection_id + +related: + - serverselection.delete + - serverselection.create + - serverselection.list diff --git a/messages/v1/messages/old/serverselection.user.remove.yml b/messages/v1/messages/old/serverselection.user.remove.yml new file mode 100644 index 0000000..121b299 --- /dev/null +++ b/messages/v1/messages/old/serverselection.user.remove.yml @@ -0,0 +1,41 @@ +--- +uri: serverselection.user.remove + +description: | + Dissocie un utilisateur d'une sélection de serveurs. + +sampleuse: | + zephir-client serverselection.remove.user -s 1 -u yo + +pattern: rpc + +public: true + +domain: serverselection-domain + +parameters: + serverselectionid: + type: Number + shortarg: s + ref: ServerSelection.ServerSelectionId + description: | + Identifiant de la sélection de serveurs. + username: + type: String + shortarg: u + description: | + Nom de l'utilisateur auquel appartient la sélection de serveurs. + +response: + type: ServerSelection + description: Description de la sélection modifiée. + +errors: + - uri: serverselection.error.database_not_available + - uri: serverselection.error.invalid_serverselection_id + - uri: serverselection.error.invalid_server_id + +related: + - serverselection.delete + - serverselection.create + - serverselection.list diff --git a/messages/v1/messages/old/serverselection.user.role.get.yml b/messages/v1/messages/old/serverselection.user.role.get.yml new file mode 100644 index 0000000..e0e2fe3 --- /dev/null +++ b/messages/v1/messages/old/serverselection.user.role.get.yml @@ -0,0 +1,38 @@ +--- +uri: serverselection.user.role.get + +description: | + Retourne le rôle d'utilisateur sur une selection de serveurs. + +sampleuse: | + zephir-client serverselection.user.role.get -d '{}' + +pattern: rpc + +public: false + +domain: serverselection-domain + +parameters: + serverselectionid: + type: Number + ref: ServerSelection.ServerSelectionId + description: | + Identifiant de la sélection de serveurs. + username: + type: String + description: | + Nom de l'utilisateur. + +response: + type: ServerSelectionUserRole + description: Rôles de l'utilisateur dans les sélections de serveurs. + +errors: + - uri: serverselection.error.database_not_available + - uri: serverselection.error.invalid_serverselection_id + +related: + - serverselection.delete + - serverselection.create + - serverselection.list diff --git a/messages/v1/messages/old/serverselection.user.role.server.get.yml b/messages/v1/messages/old/serverselection.user.role.server.get.yml new file mode 100644 index 0000000..aa1b521 --- /dev/null +++ b/messages/v1/messages/old/serverselection.user.role.server.get.yml @@ -0,0 +1,36 @@ +--- +uri: serverselection.user.role.server.get + +description: | + Retourne le rôle d'un utlisateur sur un serveur. + +sampleuse: | + zephir-client serverselection.user.role.server.get -d '{}' + +pattern: rpc + +public: false +domain: serverselection-domain + +parameters: + serverid: + type: Number + description: | + Identifiant du serveur. + username: + type: String + description: | + Nom de l'utilisateur. + +response: + type: ServerSelectionUserRole + description: Rôles de l'utilisateur dans les sélections de serveurs. + +errors: + - uri: serverselection.error.database_not_available + - uri: serverselection.error.invalid_serverselection_id + +related: + - serverselection.delete + - serverselection.create + - serverselection.list diff --git a/messages/v1/messages/old/serverselection.user.update.yml b/messages/v1/messages/old/serverselection.user.update.yml new file mode 100644 index 0000000..fd6b7bf --- /dev/null +++ b/messages/v1/messages/old/serverselection.user.update.yml @@ -0,0 +1,46 @@ +--- +uri: serverselection.user.update + +description: | + Modifie le rôle d'un utilisateur pour une sélection de serveurs. + +sampleuse: | + zephir-client serverselection.update.user -s 1 -u yo -r admin + +pattern: rpc + +public: true + +domain: serverselection-domain + +parameters: + serverselectionid: + type: Number + shortarg: s + ref: ServerSelection.ServerSelectionId + description: | + Identifiant de la sélection de serveur + username: + type: String + shortarg: u + description: | + Nom de l'utilisateur auquel appartient la sélection de serveurs. + role: + type: String + shortarg: r + description: | + Rôle de l'utilisateur. + +response: + type: ServerSelection + description: Description de la sélection modifiée. + +errors: + - uri: serverselection.error.database_not_available + - uri: serverselection.error.invalid_serverselection_id + - uri: serverselection.error.invalid_server_id + +related: + - serverselection.delete + - serverselection.create + - serverselection.list diff --git a/messages/v1/messages/old/vault.database.create.yml b/messages/v1/messages/old/vault.database.create.yml new file mode 100644 index 0000000..c601e18 --- /dev/null +++ b/messages/v1/messages/old/vault.database.create.yml @@ -0,0 +1,27 @@ +--- +uri: vault.database.create + +description: | + Enregistre les paramètres d’accès à une base de donnée. + +sampleuse: ~ + +pattern: rpc + +public: false + +domain: vault-domain + +parameters: + name: + type: String + description: | + Nom de la base de données pour laquelle les accès sont sollicités. + persistent: + type: Boolean + description: L'utilisateur est persistant. + default: false + +response: + type: Boolean + description: La base a été créée. diff --git a/messages/v1/messages/old/vault.database.get.yml b/messages/v1/messages/old/vault.database.get.yml new file mode 100644 index 0000000..c2ae0c0 --- /dev/null +++ b/messages/v1/messages/old/vault.database.get.yml @@ -0,0 +1,27 @@ +--- +uri: vault.database.get + +description: | + Demande les paramètres d’accès à une base de donnée. + +sampleuse: ~ + +pattern: rpc + +public: false + +domain: vault-domain + +parameters: + name: + type: String + description: | + Nom de la base de données pour laquelle les accès sont sollicités. + persistent: + type: Boolean + description: L'utilisateur est persistant. + default: false + +response: + type: VaultDatabase + description: Informations sur la base. diff --git a/messages/v1/messages/old/vault.error.database_not_available.yml b/messages/v1/messages/old/vault.error.database_not_available.yml new file mode 100644 index 0000000..368d587 --- /dev/null +++ b/messages/v1/messages/old/vault.error.database_not_available.yml @@ -0,0 +1,19 @@ +--- +uri: vault.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: vault-domain diff --git a/messages/v1/messages/old/vault.error.secret-not-available.yml b/messages/v1/messages/old/vault.error.secret-not-available.yml new file mode 100644 index 0000000..48883b5 --- /dev/null +++ b/messages/v1/messages/old/vault.error.secret-not-available.yml @@ -0,0 +1,22 @@ +--- +uri: vault.error.secret-not-available + +sampleuse: ~ + +description: | + Fichier d'appairage en cours de génération. + +public: true + +pattern: error + +parameters: + reason: + type: String + description: | + Description supplémentaire des causes de l'erreur. + +domain: vault-domain + +related: + - vault.secret.get diff --git a/messages/v1/messages/old/vault.secret.get.yml b/messages/v1/messages/old/vault.secret.get.yml new file mode 100644 index 0000000..23a1f1e --- /dev/null +++ b/messages/v1/messages/old/vault.secret.get.yml @@ -0,0 +1,26 @@ +--- +uri: vault.secret.get + +description: | + Accès à un secret. + +sampleuse: ~ + +pattern: rpc + +public: false + +domain: vault-domain + +parameters: + secretkey: + type: String + ref: Vault.SecretKey + description: Nom du secret. + +response: + type: Dict + description: Contenu du secret. + +errors: + - uri: vault.error.secret-not-available diff --git a/messages/v1/messages/old/vault.secret.set.yml b/messages/v1/messages/old/vault.secret.set.yml new file mode 100644 index 0000000..e831d39 --- /dev/null +++ b/messages/v1/messages/old/vault.secret.set.yml @@ -0,0 +1,32 @@ +--- +uri: vault.secret.set + +description: | + Enregistre un secret. + +sampleuse: ~ + +pattern: rpc + +public: false + +domain: vault-domain + +parameters: + secretkey: + type: String + ref: Vault.SecretKey + description: | + Nom du secret. + secret: + type: Dict + ref: Vault.Secret + description: | + Contenu du secret. + +response: + type: Boolean + description: Status. + +errors: + - uri: vault.error.secret-not-available diff --git a/messages/v1/messages/old/zephir.services.available.yml b/messages/v1/messages/old/zephir.services.available.yml new file mode 100644 index 0000000..bdde99d --- /dev/null +++ b/messages/v1/messages/old/zephir.services.available.yml @@ -0,0 +1,19 @@ +--- +uri: zephir.services.available + +sampleuse: ~ + +description: | + Un service est disponible. + +pattern: event + +parameters: + name: + type: String + description: Nom du service. + default: null + +public: false + +domain: zephir-domain diff --git a/messages/v1/messages/old/zephir.services.event.yml b/messages/v1/messages/old/zephir.services.event.yml new file mode 100644 index 0000000..7f13b61 --- /dev/null +++ b/messages/v1/messages/old/zephir.services.event.yml @@ -0,0 +1,25 @@ +--- +uri: zephir.services.event + +sampleuse: ~ + +description: | + Événement sur les services (démarrage/arrêt/...). + +pattern: event + +parameters: + name: + type: String + description: Nom du service. + ip: + type: String + description: Adresse IP du service. + status: + type: String + description: | + État du service. + +public: false + +domain: zephir-domain diff --git a/messages/v1/types/config.configuration.status.yml b/messages/v1/types/config.configuration.status.yml new file mode 100644 index 0000000..a93ef2c --- /dev/null +++ b/messages/v1/types/config.configuration.status.yml @@ -0,0 +1,24 @@ +--- +title: ConfigConfigurationStatus +type: object +description: Statut de la configuration. +properties: + session_id: + type: string + description: ID de la session. + ref: Config.SessionId + status: + type: string + description: Statut de la configuration (peut être ok, error, incomplete) + message: + type: string + description: Message d'erreur si la configuration a le statut error. + mandatories: + type: array + items: + type: string + description: Liste des variables obligatoires non renseignées si la configuration a le statut incomplete. +required: + - sessionid + - status + diff --git a/messages/v1/types/config.configuration.yml b/messages/v1/types/config.configuration.yml new file mode 100644 index 0000000..05aaee5 --- /dev/null +++ b/messages/v1/types/config.configuration.yml @@ -0,0 +1,10 @@ +--- +title: ConfigConfiguration +type: object +description: Description de la configuration. +properties: + configuration: + type: File + description: Détail de la configuration au format JSON. +required: + - configuration diff --git a/messages/v1/types/config.session.yml b/messages/v1/types/config.session.yml new file mode 100644 index 0000000..eef9239 --- /dev/null +++ b/messages/v1/types/config.session.yml @@ -0,0 +1,39 @@ +--- +title: ConfigSession +type: object +description: Description de la session. +properties: + sessionid: + type: string + description: ID de la session. + ref: Config.SessionId + id: + type: number + description: ID de la configuration. + ref: Server.ServerId + username: + type: string + description: Nom de l'utilisateur. + timestamp: + type: number + description: Moment d’ouverture de la session. + namespace: + type: string + description: Namespace de la configuration. + mode: + type: string + description: Mode de la configuration. + debug: + type: boolean + description: La configuration est en mode debug. + content: + type: file + description: Contenu de la configuration. +required: + - sessionid + - id + - username + - timestamp + - namespace + - mode + - debug diff --git a/messages/v1/types/config.status.yml b/messages/v1/types/config.status.yml new file mode 100644 index 0000000..10f5a24 --- /dev/null +++ b/messages/v1/types/config.status.yml @@ -0,0 +1,24 @@ +--- +title: ConfigStatus +type: object +description: Status de la modification de la configuration. +properties: + session_id: + type: string + description: Identifiant de la configuration. + name: + type: string + description: Nom de la variable a modifier. + index: + type: number + description: Index de la variable a modifier. + status: + type: string + description: Status de la modification. + message: + type: string + description: Message d'erreur. +required: + - session_id + - name + - status diff --git a/messages/v1/types/execution.salt.exec.yml b/messages/v1/types/execution.salt.exec.yml new file mode 100644 index 0000000..6c80737 --- /dev/null +++ b/messages/v1/types/execution.salt.exec.yml @@ -0,0 +1,17 @@ +--- +title: SaltExec +type: object +description: Description du job exécuté dans Salt. +properties: + jid: + type: string + description: ID de la tâche Salt. + ref: Server.JobId + minions: + type: array + items: + type: string + description: Minions devant exécuter la tâche. +required: + - jid + - servers_id diff --git a/messages/v1/types/execution.salt.job.yml b/messages/v1/types/execution.salt.job.yml new file mode 100644 index 0000000..a6c9360 --- /dev/null +++ b/messages/v1/types/execution.salt.job.yml @@ -0,0 +1,35 @@ +--- +title: SaltJob +type: object +description: Description d'un job Salt exécuté précédement. +properties: + jid: + type: string + ref: Server.JobId + description: Identifiant de la tâche. + executed: + type: boolean + description: La tâche a été exécutée. + command: + type: string + description: Nom de la fonction. + arg: + type: string + description: Commande exécuté. + minion: + type: string + description: Identifiant du minion. + success: + type: boolean + description: Commande exécuté avec succès. + retcode: + type: number + description: Code de retour de la commande. + return: + type: string + description: Retour de la commande. +required: + - jid + - executed + - fun + - minion diff --git a/messages/v1/types/identity.session.yml b/messages/v1/types/identity.session.yml new file mode 100644 index 0000000..a9e44fa --- /dev/null +++ b/messages/v1/types/identity.session.yml @@ -0,0 +1,13 @@ +--- +title: IdentitySession +type: object +description: Informations sur l'identité de l'utilisateur. +properties: + username: + type: string + description: Nom de l'utilisateur. + profil: + type: string + description: Profil de l'utilisateur +required: + - username diff --git a/messages/v1/types/identity.settings.yml b/messages/v1/types/identity.settings.yml new file mode 100644 index 0000000..12f8df7 --- /dev/null +++ b/messages/v1/types/identity.settings.yml @@ -0,0 +1,26 @@ +--- +title: IdentitySettings +type: object +description: Préférence de l'utilisateur. +properties: + username: + type: String + ref: Identity.username + description: Identifiant de l'utilisateur. + sshkey: + type: String + description: Clé publique ssh. + firstname: + type: String + description: Prénom de l'utilisateur. + lastname: + type: String + description: Nom de l'utilisateur. + email: + type: String + description: Adresse email de l'utilisateur. + alertes: + type: Boolean + description: Activer les alertes email. +required: + - username diff --git a/messages/v1/types/server.describe.yml b/messages/v1/types/server.describe.yml new file mode 100644 index 0000000..2eba51e --- /dev/null +++ b/messages/v1/types/server.describe.yml @@ -0,0 +1,44 @@ +--- +title: ServerDescribe +type: object +description: Description du serveur. +properties: + serverid: + type: number + description: Identifiant du serveur. + ref: Server.ServerId + servername: + type: string + description: Nom du serveur. + serverdescription: + type: string + description: Description du serveur. + servermodelid: + type: number + description: Identifiant du modèle de serveur. + ref: Servermodel.ServermodelId + zoneid: + type: number + description: Identifiant de la zone. + ref: Zone.ZoneId + machineid: + type: number + description: Identifiant de la machine. + ref: Zone.MachineId + configuration: + type: file + description: Valeurs de configuration. + serverenvironment: + type: object + description: Variables d'environnement du serveur. + peering: + type: object + description: Clé d'appairage. + lastpeerconnection: + type: string + description: Timestamp de la dernière connexion avec le serveur. +required: + - serverid + - servername + - serverdescription + - servermodelid diff --git a/messages/v1/types/server.exec.yml b/messages/v1/types/server.exec.yml new file mode 100644 index 0000000..93183c7 --- /dev/null +++ b/messages/v1/types/server.exec.yml @@ -0,0 +1,38 @@ +--- +title: ServerExec +type: object +description: Retour de l'exécution. +properties: + job_id: + type: string + description: Identifiant de la tâche. + ref: Server.JobId + server_id: + type: number + description: Identifiant du serveur. + ref: Server.ServerId + command: + type: string + description: Commande demandée. + automation: + type: string + description: Moteur d'exécution. + ref: Server.automation + executed: + type: boolean + description: La tâche a été exécutée. + success: + type: boolean + description: Commande exécuté avec succès. + retcode: + type: number + description: Code de retour de la commande. + return: + type: string + description: Retour de la commande. +required: + - command + - automation + - job_id + - server_id + - executed diff --git a/messages/v1/types/server.job.yml b/messages/v1/types/server.job.yml new file mode 100644 index 0000000..d589b07 --- /dev/null +++ b/messages/v1/types/server.job.yml @@ -0,0 +1,28 @@ +--- +title: ServerJob +type: object +description: Description d'une tâche exécutée précédement. +properties: + job_id: + type: string + ref: Server.JobId + description: Identifiant de la tâche. + command: + type: string + description: Commande exécuté. + automation: + type: string + description: Moteur d'exécution. + ref: Server.automation + executed: + type: boolean + description: La tâche a été exécutée. + success: + type: boolean + description: Etat de la commande. +required: + - job_id + - command + - automation + - executed + - success diff --git a/messages/v1/types/server.yml b/messages/v1/types/server.yml new file mode 100644 index 0000000..b45f0cd --- /dev/null +++ b/messages/v1/types/server.yml @@ -0,0 +1,39 @@ +--- +title: Server +type: object +description: Description du serveur. +properties: + serverid: + type: number + description: Identifiant du serveur. + ref: Server.ServerId + servername: + type: string + description: Nom du serveur. + serverdescription: + type: string + description: Description du serveur. + servermodelid: + type: number + description: Identifiant du modèle de serveur. + ref: Servermodel.ServermodelId + zoneid: + type: number + description: Identifiant de la zone. + ref: Zone.ZoneId + machineid: + type: number + description: Identifiant de la machine. + ref: Zone.MachineId + automation: + type: string + description: Moteur d'exécution. + ref: Server.automation + lastpeerconnection: + type: string + description: Timestamp de la dernière connexion avec le serveur. +required: + - serverid + - servername + - serverdescription + - servermodelid diff --git a/messages/v1/types/servermodel.source.yml b/messages/v1/types/servermodel.source.yml new file mode 100644 index 0000000..5fdc8d6 --- /dev/null +++ b/messages/v1/types/servermodel.source.yml @@ -0,0 +1,18 @@ +--- +title: ServermodelSource +type: object +description: Description de la source. +properties: + sourceid: + type: number + description: ID de la source. + sourcename: + type: string + description: Nom de la source. + sourceurl: + type: string + description: URL de la source. +required: + - sourceid + - sourcename + - sourceurl diff --git a/messages/v1/types/servermodel.version.yml b/messages/v1/types/servermodel.version.yml new file mode 100644 index 0000000..7505ec7 --- /dev/null +++ b/messages/v1/types/servermodel.version.yml @@ -0,0 +1,22 @@ +--- +title: ServermodelVersion +type: object +description: Description de la configuration. +properties: + subreleaseid: + type: number + description: ID de la sous-version. + subreleasename: + type: string + description: Nom de la sous-version. + versionname: + type: string + description: Nom de la version. + versiondistribution: + type: string + description: Nom de la distribution. +required: + - subreleaseid + - subreleasename + - versionname + - versiondistribution diff --git a/messages/v1/types/servermodel.yml b/messages/v1/types/servermodel.yml new file mode 100644 index 0000000..1d2ff34 --- /dev/null +++ b/messages/v1/types/servermodel.yml @@ -0,0 +1,57 @@ +--- +title: Servermodel +type: object +description: Description d'un modèle de serveur. +properties: + servermodelid: + type: number + description: ID du modèle de serveur. + ref: Servermodel.ServermodelId + servermodelname: + type: string + description: Nom du modèle de serveur. + servermodeldescription: + type: string + description: Description du modèle de serveur. + servermodelparentsid: + type: array + items: + type: number + ref: Servermodel.ServermodelId + description: ID du modèle de serveur parent. + subreleaseid: + type: number + ref: Servermodel.SubreleaseId + description: Version du modèle de serveur. + subreleasename: + type: string + ref: SubRelease.SubReleaseName + description: Nom de la sous-version. + sourceid: + type: number + ref: ServermodelId.SourceId + description: ID de la sous-version. + services: + type: array + items: + type: object + description: Liste des services applicatifs déclarés pour ce modèle de serveur. + schema: + type: File + description: Contenu du schema. + probes: + type: File + description: Informations sur les sondes. + creolefuncs: + type: File + description: Fonctions Creole. + conffiles: + type: File + description: Fichiers creole au format tar encodé base64 +required: + - servermodelid + - servermodelname + - servermodeldescription + - servermodelsubreleaseid + - sourceid + - subreleasename diff --git a/messages/v1/types/serverselection.exec.yml b/messages/v1/types/serverselection.exec.yml new file mode 100644 index 0000000..52eaa0a --- /dev/null +++ b/messages/v1/types/serverselection.exec.yml @@ -0,0 +1,27 @@ +--- +title: ServerSelectionExec +type: object +description: Retour de l'exécution. +properties: + job_id: + type: string + description: Identifiant de la tâche. + ref: Server.JobId + servers_id: + type: array + items: + type: number + description: Identifiants des serveurs. + ref: Server.ServerId + command: + type: string + description: Commande demandée. + automation: + type: string + description: Moteur d'exécution. + ref: Server.automation +required: + - command + - automation + - job_id + - server_id diff --git a/messages/v1/types/serverselection.userrole.yml b/messages/v1/types/serverselection.userrole.yml new file mode 100644 index 0000000..a5b2d34 --- /dev/null +++ b/messages/v1/types/serverselection.userrole.yml @@ -0,0 +1,16 @@ +--- +title: ServerSelectionUserRole +type: object +description: Rôle d'un utilisateur sur une sélection de serveurs. +properties: + serverselectionid: + type: number + description: Identifiant de la sélection de serveurs. + username: + type: string + description: Nom de l'utilisateur. + role: + type: string + description: Rôle de l'utilisateur. +required: + - serverselectionid diff --git a/messages/v1/types/serverselection.yml b/messages/v1/types/serverselection.yml new file mode 100644 index 0000000..62e5ac7 --- /dev/null +++ b/messages/v1/types/serverselection.yml @@ -0,0 +1,34 @@ +--- +title: ServerSelection +type: object +description: Description de la sélection de serveurs. +properties: + serverselectionid: + type: number + description: Identifiant de la sélection de serveurs. + serverselectionname: + type: string + description: Nom de la sélection de serveurs. + serverselectiondescription: + type: string + description: Description de la sélection de serveur. + serverid: + type: array + items: + type: number + description: | + Identifiants des serveurs de la sélection + serverselectionusers: + type: object + description: | + Nom de l'utilisateur et rôle auquel appartient la serverselection + dynamique: + type: boolean + description: | + La sélection est-elle dynamique + requete: + type: string + description: | + Requete de la sélection +required: + - serverselectionid diff --git a/messages/v1/types/vault.database.yml b/messages/v1/types/vault.database.yml new file mode 100644 index 0000000..b47f6c9 --- /dev/null +++ b/messages/v1/types/vault.database.yml @@ -0,0 +1,21 @@ +--- +title: VaultDatabase +type: object +description: Informations sur la base. +properties: + host: + type: string + description: | + Adresse de l’hôte hébergeant Postgresql + username: + type: string + description: | + Nom de l'utilisateur utilisé pour accéder à la base + password: + type: string + description: | + Mot de passe de l'utilisateur utilisé pour accéder à la base +required: + - host + - username + - password diff --git a/messages/v1/types/zone.site.yml b/messages/v1/types/zone.site.yml new file mode 100644 index 0000000..4fe8798 --- /dev/null +++ b/messages/v1/types/zone.site.yml @@ -0,0 +1,23 @@ +--- +title: ZoneSite +type: object +description: Informations sur un site. +properties: + siteid: + type: number + description: ID du site. + ref: Zone.SiteId + name: + type: string + description: Nom du site. + description: + type: string + description: Desription du site + parentid: + type: number + description: ID du site parent + ref: Zone.SiteId +required: + - siteid + - name + - description diff --git a/script/server.py b/script/server.py new file mode 100644 index 0000000..68630bc --- /dev/null +++ b/script/server.py @@ -0,0 +1,6 @@ +from aiohttp.web import run_app +from risotto import get_app + +if __name__ == '__main__': + run_app(get_app()) + diff --git a/src/risotto/__init__.py b/src/risotto/__init__.py new file mode 100644 index 0000000..f39be6d --- /dev/null +++ b/src/risotto/__init__.py @@ -0,0 +1,8 @@ +from .utils import undefined +from .dispatcher import register, dispatcher +from .http import get_app +# just to register every route +from . import services as _services + +__ALL__ = ('undefined', 'register', 'dispatcher', 'get_app') + diff --git a/src/risotto/config.py b/src/risotto/config.py new file mode 100644 index 0000000..bd3055d --- /dev/null +++ b/src/risotto/config.py @@ -0,0 +1,3 @@ +HTTP_PORT = 8080 +MESSAGE_ROOT_PATH = 'messages' +DEBUG = True diff --git a/src/risotto/context.py b/src/risotto/context.py new file mode 100644 index 0000000..835b035 --- /dev/null +++ b/src/risotto/context.py @@ -0,0 +1,3 @@ +class Context: + def __init__(self): + self.paths = [] diff --git a/src/risotto/controller.py b/src/risotto/controller.py new file mode 100644 index 0000000..adc87dd --- /dev/null +++ b/src/risotto/controller.py @@ -0,0 +1,7 @@ +from .dispatcher import dispatcher + + +class Controller: + async def call(self, uri, risotto_context, **kwargs): + version, uri = uri.split('.', 1) + return await dispatcher.call(version, uri, risotto_context, **kwargs) diff --git a/src/risotto/dispatcher.py b/src/risotto/dispatcher.py new file mode 100644 index 0000000..448e12f --- /dev/null +++ b/src/risotto/dispatcher.py @@ -0,0 +1,178 @@ +from tiramisu import Config +from inspect import signature +from traceback import print_exc +from copy import copy + +from .utils import undefined, _ +from .error import RegistrationError, CallError, NotAllowedError +from .message import get_messages +from .logger import log +from .config import DEBUG +from .context import Context + + +def register(uri: str, + notification: str=undefined): + version, uri = uri.split('.', 1) + def decorator(function): + dispatcher.set_function(version, uri, function) + return decorator + + +class URI: + def __init__(self, ): + self.functions = {} + + +class Dispatcher: + def __init__(self): + self.modules = {} + self.uris = {} + self.function_names = {} + self.messages, self.option = get_messages() + config = Config(self.option) + + def get_function_args(self, function): + # remove self + first_argument_index = 1 + return [param.name for param in list(signature(function).parameters.values())[first_argument_index:]] + + def _valid_rpc_params(self, version, uri, function, module_name): + """ parameters function must have strictly all arguments with the correct name + """ + def get_message_args(): + # load config + config = Config(self.option) + config.property.read_write() + # set message to the uri name + config.option('message').value.set(uri) + # get message argument + subconfig = config.option(uri) + return set(config.option(uri).value.dict().keys()) + + # compare message arguments with function parameter + # it must not have more or less arguments + message_args = get_message_args() + function_args = self.get_function_args(function) + # risotto_context is a special argument, remove it + if function_args[0] == 'risotto_context': + function_args = function_args[1:] + function_args = set(function_args) + if message_args != function_args: + msg = [] + missing_function_args = message_args - function_args + if missing_function_args: + msg.append(_(f'missing arguments: {missing_function_args}')) + extra_function_args = function_args - message_args + if extra_function_args: + msg.append(_(f'extra arguments: {extra_function_args}')) + function_name = function.__name__ + msg = _(' and ').join(msg) + raise RegistrationError(_(f'error with {module_name}.{function_name} arguments: {msg}')) + + + + def set_function(self, version, uri, function): + """ register a function to an URI + URI is a message + """ + # xxx module can only be register with v1.xxxx..... message + module_name = function.__module__.split('.')[-2] + uri_namespace = uri.split('.', 1)[0] + if uri_namespace != module_name: + raise RegistrationError(_(f'cannot registered to {uri} message in module {module_name}')) + + # check if message exists + try: + if not Config(self.option).option(uri).option.type() == 'message': + raise RegistrationError(_(f'{uri} is not a valid message')) + except AttributeError: + raise RegistrationError(_(f'{uri} is not a valid message')) + + # check if a function is already register for this uri + if version not in self.uris: + self.uris[version] = {} + self.function_names[version] = {} + if uri in self.uris[version]: + raise RegistrationError(_(f'uri {uri} already imported')) + + # valid function's arguements + self._valid_rpc_params(version, uri, function, module_name) + + # valid function is unique per module + if module_name not in self.function_names[version]: + self.function_names[version][module_name] = [] + function_name = function.__name__ + if function_name in self.function_names[version][module_name]: + raise RegistrationError(_(f'multiple registration of {module_name}.{function_name} function')) + self.function_names[version][module_name].append(function_name) + + # True if first argument is the risotto_context + inject_risotto_context = self.get_function_args(function)[0] == 'risotto_context' + + # register this function + self.uris[version][uri] = {'module': module_name, + 'function': function, + 'risotto_context': inject_risotto_context} + + def set_module(self, module_name, module): + """ register a new module + """ + try: + self.modules[module_name] = module.Risotto() + except AttributeError as err: + raise RegistrationError(_(f'unable to register the module {module_name}, this module must have Risotto class')) + + def validate(self): + """ check if all messages have a function + """ + # FIXME only v1 supported + missing_messages = set(self.messages.keys()) - set(self.uris['v1'].keys()) + if missing_messages: + raise RegistrationError(_(f'missing uri {missing_messages}')) + + async def call(self, version, uri, risotto_context, public_only=False, **kwargs): + """ execute the function associate with specified uri + arguments are validate before + """ + new_context = Context() + new_context.paths = copy(risotto_context.paths) + new_context.paths.append(version + '.' + uri) + new_context.username = risotto_context.username + if public_only and not self.messages[uri]: + raise NotAllowedError() + try: + config = Config(self.option) + config.property.read_write() + config.option('message').value.set(uri) + subconfig = config.option(uri) + for key, value in kwargs.items(): + try: + subconfig.option(key).value.set(value) + except ValueError as err: + raise ValueError(str(err)) + except AttributeError: + raise AttributeError(_(f'unknown parameter "{key}"')) + config.property.read_only() + mandatories = list(config.value.mandatory()) + if mandatories: + mand = [mand.split('.')[-1] for mand in mandatories] + raise ValueError(_(f'missing parameters: {mand}')) + obj = self.uris[version][uri] + kw = config.option(uri).value.dict() + if obj['risotto_context']: + kw['risotto_context'] = new_context + returns = await obj['function'](self.modules[obj['module']], **kw) + except CallError as err: + raise err + except Exception as err: + if DEBUG: + print_exc() + log.error_msg(version, uri, new_context, kwargs, err) + raise CallError(str(err)) + log.info_msg(version, uri, new_context, kwargs, returns) + return returns + + +dispatcher = Dispatcher() + diff --git a/src/risotto/error.py b/src/risotto/error.py new file mode 100644 index 0000000..9c861ba --- /dev/null +++ b/src/risotto/error.py @@ -0,0 +1,10 @@ +class RegistrationError(Exception): + pass + + +class CallError(Exception): + pass + + +class NotAllowedError(Exception): + pass diff --git a/src/risotto/http.py b/src/risotto/http.py new file mode 100644 index 0000000..2880ff8 --- /dev/null +++ b/src/risotto/http.py @@ -0,0 +1,41 @@ +from aiohttp.web import Application, Response, get, HTTPBadRequest, HTTPInternalServerError, HTTPNotFound +from .dispatcher import dispatcher +from .utils import _ +from .context import Context +from .error import CallError, NotAllowedError + + +async def handle(request): + version, uri = request.match_info.get_info()['path'].split('/', 2)[-2:] + context = Context() + context.username = request.match_info.get('name', "Anonymous") + try: + text = await dispatcher.call(version, uri, context, id=2, public_only=True) + except NotAllowedError as err: + raise HTTPNotFound(reason=_(f'the message {version}.{uri} is private')) + except CallError as err: + raise HTTPBadRequest(reason=str(err)) + except Exception as err: + raise HTTPInternalServerError(reason=str(err)) + + return Response(text=str(text)) + + +def get_app(): + app = Application() + routes = [] + uris = list(dispatcher.uris.items()) + uris.sort() + for version, uris in dispatcher.uris.items(): + print() + print(_('======== Registered messages ========')) + for uri in uris: + web_uri = f'/{version}/{uri}' + if dispatcher.messages[uri]: + print(f' - {web_uri}') + else: + print(f' - {web_uri} (private)') + routes.append(get(web_uri, handle)) + print() + app.add_routes(routes) + return app diff --git a/src/risotto/logger.py b/src/risotto/logger.py new file mode 100644 index 0000000..ba3f0ed --- /dev/null +++ b/src/risotto/logger.py @@ -0,0 +1,23 @@ +from .utils import _ + + +class Logger: + def _get_message_paths(self, risotto_context): + paths = risotto_context.paths + if len(paths) == 1: + paths_msg = f'messages called: {paths[0]}' + else: + paths_msg = f'sub-messages called: ' + paths_msg += ' > '.join(paths) + return paths_msg + + def error_msg(self, version, message, risotto_context, arguments, error): + paths_msg = self._get_message_paths(risotto_context) + print(_(f'{risotto_context.username}: {error} ({paths_msg} with arguments "{arguments}")')) + + def info_msg(self, version, message, risotto_context, arguments, returns): + paths_msg = self._get_message_paths(risotto_context) + print(_(f'{risotto_context.username}: {paths_msg} with arguments "{arguments}" returns {returns}')) + + +log = Logger() diff --git a/src/risotto/message/__init__.py b/src/risotto/message/__init__.py new file mode 100644 index 0000000..cf315cf --- /dev/null +++ b/src/risotto/message/__init__.py @@ -0,0 +1 @@ +from .message import get_messages diff --git a/src/risotto/message/message.py b/src/risotto/message/message.py new file mode 100644 index 0000000..f166362 --- /dev/null +++ b/src/risotto/message/message.py @@ -0,0 +1,610 @@ +from collections import OrderedDict +from os.path import join, basename, dirname +from glob import glob + +from tiramisu import StrOption, IntOption, BoolOption, ChoiceOption, OptionDescription, SymLinkOption, \ + Config, Calculation, Params, ParamOption, ParamValue, calc_value, calc_value_property_help, \ + groups + +from yaml import load, SafeLoader +from os import listdir +from os.path import isfile +from ..config import MESSAGE_ROOT_PATH +from ..utils import _ + + +groups.addgroup('message') + + +class MessageDefinition: + """ + A MessageDefinition is a representation of a message in the Zephir application messaging context + """ + __slots__ = ('version', + 'uri', + 'description', + 'sampleuse', + 'domain', + 'parameters', + 'public', + 'errors', + 'pattern', + 'related', + 'response') + + def __init__(self, raw_def): + # default value for non mandatory key + self.version = u'' + self.parameters = OrderedDict() + self.public = False + self.errors = [] + self.related = [] + self.response = None + self.sampleuse = None + + # loads yaml information into object + for key, value in raw_def.items(): + if isinstance(value, str): + value = value.strip() + if key == 'public': + if not isinstance(value, bool): + raise ValueError(_("{} must be a boolean, not {}").format(key, value)) + elif key == 'pattern': + if value not in ['rpc', 'event', 'error']: + raise Exception(_('unknown pattern {}').format(value)) + elif key == 'parameters': + if 'type' in value and isinstance(value['type'], str): + # should be a customtype + value = customtypes[value['type']].properties + else: + value = _parse_parameters(value) + elif key == 'response': + value = ResponseDefinition(value) + elif key == 'errors': + value = _parse_error_definition(value) + setattr(self, key, value) + # check mandatory keys + for key in self.__slots__: + try: + getattr(self, key) + except AttributeError: + raise Exception(_('mandatory key not set {} message').format(key)) + # message with pattern = error must be public + if self.public is False and self.pattern == 'error': + raise Exception(_('Error message must be public : {}').format(self.uri)) + + +class ParameterDefinition: + __slots__ = ('name', + 'type', + 'description', + 'help', + 'default', + 'ref', + 'shortarg') + + def __init__(self, name, raw_def): + self.name = name + # default value for non mandatory key + self.help = None + self.ref = None + self.shortarg = None + + # loads yaml information into object + for key, value in raw_def.items(): + if isinstance(value, str): + value = value.strip() + if key == 'type': + if value.startswith('[]'): + tvalue = value[2:] + else: + tvalue = value + if tvalue in customtypes: + if value.startswith('[]'): + value = '[]{}'.format(customtypes[tvalue].type) + else: + value = customtypes[value].type + else: + self._valid_type(value) + #self._valid_type(value) + setattr(self, key, value) + # check mandatory keys + for key in self.__slots__: + try: + getattr(self, key) + except AttributeError: + if key != 'default': + raise Exception(_('mandatory key not set "{}" in parameter').format(key)) + + def _valid_type(self, typ): + if typ.startswith('[]'): + self._valid_type(typ[2:]) + elif typ not in ['Boolean', 'String', 'Number', 'File', 'Dict', 'Any']: + raise Exception(_('unknown parameter type: {}').format(typ)) + +class ResponseDefinition: + """ + An ResponseDefinition is a representation of a response in the Zephir application messaging context + """ + __slots__ = ('description', + 'type', + 'ref', + 'parameters', + 'required') + + def __init__(self, responses): + self.ref = None + self.parameters = None + self.required = [] + for key, value in responses.items(): + if key in ['parameters', 'required']: + raise Exception(_('parameters and required must be set with a custom type')) + elif key == 'type': + if value.startswith('[]'): + tvalue = value[2:] + else: + tvalue = value + if tvalue in customtypes: + self.parameters = customtypes[tvalue].properties + self.required = customtypes[tvalue].required + if value.startswith('[]'): + value = '[]{}'.format(customtypes[tvalue].type) + else: + value = customtypes[value].type + else: + self._valid_type(value) + setattr(self, key, value) + # check mandatory keys + for key in self.__slots__: + try: + getattr(self, key) + except AttributeError: + raise Exception(_('mandatory key not set {}').format(key)) + + def _valid_type(self, typ): + if typ.startswith('[]'): + self._valid_type(typ[2:]) + elif typ not in ['Boolean', 'String', 'Number', 'File', 'Dict']: + raise Exception(_('unknown parameter type: {}').format(typ)) + + +class ErrorDefinition: + """ + An ErrorDefinition is a representation of an error in the Zephir application messaging context + """ + __slots__ = ('uri',) + + def __init__(self, raw_err): + extra_keys = set(raw_err) - set(self.__slots__) + if extra_keys: + raise Exception(_('extra keys for errors: {}').format(extra_keys)) + self.uri = raw_err['uri'] + + +def _parse_error_definition(raw_defs): + new_value = [] + for raw_err in raw_defs: + new_value.append(ErrorDefinition(raw_err)) + return new_value + + +def _parse_parameters(raw_defs): + parameters = OrderedDict() + for name, raw_def in raw_defs.items(): + parameters[name] = ParameterDefinition(name, raw_def) + return parameters + + +def parse_definition(filename: str): + return MessageDefinition(load(filename, Loader=SafeLoader)) + +def is_message_defined(uri): + version, message = split_message_uri(uri) + path = get_message_file_path(version, message) + return isfile(path) + +def get_message(uri): + load_customtypes() + try: + version, message = split_message_uri(uri) + path = get_message_file_path(version, message) + with open(path, "r") as message_file: + message_content = parse_definition(message_file.read()) + message_content.version = version + return message_content + except Exception as err: + import traceback + traceback.print_exc() + raise Exception(_('cannot parse message {}: {}').format(uri, str(err))) + +def split_message_uri(uri): + return uri.split('.', 1) + +def get_message_file_path(version, message): + return join(MESSAGE_ROOT_PATH, version, 'messages', message + '.yml') + +def list_messages(): + messages = listdir(MESSAGE_ROOT_PATH) + messages.sort() + for version in messages: + for message in listdir(join(MESSAGE_ROOT_PATH, version, 'messages')): + if message.endswith('.yml'): + yield version + '.' + message.rsplit('.', 1)[0] + +class CustomParam: + __slots__ = ('name', + 'type', + 'description', + 'ref', + 'default') + + def __init__(self, name, raw_def, required): + self.name = name + self.ref = None + if name not in required: + self.default = None + + # loads yaml information into object + for key, value in raw_def.items(): + if isinstance(value, str): + value = value.strip() + if key == 'type': + value = self._convert_type(value, raw_def) + elif key == 'items': + continue + setattr(self, key, value) + + # check mandatory keys + for key in self.__slots__: + try: + getattr(self, key) + except AttributeError: + # default value for non mandatory key + if key != 'default': + raise Exception(_('mandatory key not set "{}" in parameter').format(key)) + + def _convert_type(self, typ, raw_def): + types = {'boolean': 'Boolean', + 'string': 'String', + 'number': 'Number', + 'object': 'Dict', + 'array': 'Array', + 'file': 'File'} + + if typ not in list(types.keys()): + # validate after + return typ + if typ == 'array' and 'items' in raw_def: + if not isinstance(raw_def['items'], dict): + raise Exception(_('items must be a dict')) + if list(raw_def['items'].keys()) != ['type']: + raise Exception(_('items must be a dict with only a type')) + return '[]{}'.format(self._convert_type(raw_def['items']['type'], raw_def)) + return types[typ] + + +def _parse_custom_params(raw_defs, required): + parameters = OrderedDict() + for name, raw_def in raw_defs.items(): + parameters[name] = CustomParam(name, raw_def, required) + return parameters + + +class CustomType: + __slots__ = ('title', + 'type', + 'description', + 'ref', + 'properties', + 'required') + + def __init__(self, raw_def): + # default value for non mandatory key + self.ref = None + + # loads yaml information into object + for key, value in raw_def.items(): + if isinstance(value, str): + value = value.strip() + if key == 'type': + value = self._convert_type(value, raw_def) + elif key == 'properties': + value = _parse_custom_params(value, raw_def.get('required', {})) + + setattr(self, key, value) + # check mandatory keys + for key in self.__slots__: + try: + getattr(self, key) + except AttributeError: + raise Exception(_('mandatory key not set "{}" in parameter').format(key)) + + def _convert_type(self, typ, raw_def): + types = {'boolean': 'Boolean', + 'string': 'String', + 'number': 'Number', + 'object': 'Dict', + 'array': 'Array'} + + if typ not in list(types.keys()): + # validate after + return typ + if typ == 'array' and 'items' in raw_def: + if not isinstance(raw_def['items'], dict): + raise Exception(_('items must be a dict')) + if list(raw_def['items'].keys()) != ['type']: + raise Exception(_('items must be a dict with only a type')) + return '[]{}'.format(self._convert_type(raw_def['items']['type'], raw_def)) + return types[typ] + + def getname(self): + return self.title + + +customtypes = {} +def load_customtypes(): + if not customtypes: + versions = listdir(MESSAGE_ROOT_PATH) + versions.sort() + for version in versions: + for message in listdir(join(MESSAGE_ROOT_PATH, version, 'types')): + if message.endswith('.yml'): + path = join(MESSAGE_ROOT_PATH, version, 'types', message) + message = message.rsplit('.', 1)[0] + with open(path, "r") as message_file: + try: + ret = CustomType(load(message_file, Loader=SafeLoader)) + customtypes[ret.getname()] = ret + except Exception as err: + import traceback + traceback.print_exc() + raise Exception('{} for {}'.format(err, message)) + for customtype in customtypes.values(): + properties = {} + for key, value in customtype.properties.items(): + type_ = value.type + if type_.startswith('[]'): + ttype_ = type_[2:] + else: + ttype_ = type_ + if ttype_ in customtypes: + if type_.startswith('[]'): + raise Exception(_('cannot have []CustomType')) + properties[key] = customtypes[ttype_] + else: + properties[key] = value + customtype.properties = properties + + +def _get_description(description, + name): + # hack because some description are, in fact some help + if not '\n' in description and len(description) <= 150: + doc = description + else: + doc = name + if doc.endswith('.'): + doc= description[:-1] + return doc + + +def _get_option(name, + arg, + file_path, + select_option, + optiondescription): + """generate option + """ + props = [] + if not hasattr(arg, 'default'): + props.append('mandatory') + props.append(Calculation(calc_value, + Params(ParamValue('disabled'), + kwargs={'condition': ParamOption(select_option, todict=True), + 'expected': ParamValue(optiondescription), + 'reverse_condition': ParamValue(True)}), + calc_value_property_help)) + + description = arg.description.strip().rstrip() + kwargs = {'name': name, + 'doc': _get_description(description, name), + 'properties': frozenset(props), + #'multi': arg.multi, + } + if hasattr(arg, 'default'): + kwargs['default'] = arg.default + type_ = arg.type + if type_ == 'Dict' or 'String' in type_ or 'Any' in type_: + return StrOption(**kwargs) + elif 'Number' in type_ or type_ == 'ID' or type_ == 'Integer': + return IntOption(**kwargs) + elif type_ == 'Boolean': + return BoolOption(**kwargs) + raise Exception('unsupported type {} in {}'.format(type_, file_path)) + + +def _parse_args(message_def, + options, + file_path, + needs, + select_option, + optiondescription, + load_shortarg): + """build option with args/kwargs + """ + new_options = OrderedDict() + for name, arg in message_def.parameters.items(): + new_options[name] = arg + if arg.ref: + needs.setdefault(message_def.uri, {}).setdefault(arg.ref, []).append(name) + for name, arg in new_options.items(): + current_opt = _get_option(name, arg, file_path, select_option, optiondescription) + options.append(current_opt) + if arg.shortarg and load_shortarg: + options.append(SymLinkOption(arg.shortarg, current_opt)) + + +def _parse_responses(message_def, + file_path): + """build option with returns + """ + responses = OrderedDict() + if message_def.response: + keys = {'': {'description': '', + 'columns': {}}} + provides = {} + to_list = True + param_type = message_def.response.type + + if param_type.startswith('[]'): + to_list = False + param_type = param_type[2:] + if param_type in ['Dict', 'File']: + pass + + if message_def.response.parameters is not None: + for name, obj in message_def.response.parameters.items(): + if name in responses: + raise Exception('multi response with name {} in {}'.format(name, file_path)) + + descr = obj.description.strip().rstrip() + keys['']['columns'][name] = {'description': obj.description, + 'type': obj.type} + ref = obj.ref + if ref: + provides[name] = ref + else: + keys['']['columns'][name] = {'description': descr, + 'type': obj.type} + ref = obj.ref + if ref: + provides[name] = ref + responses['keys'] = keys + responses['to_list'] = to_list + responses['to_dict'] = False + responses['provides'] = provides + else: + name = 'response' + keys['']['columns'][name] = {'description': message_def.response.description, + 'type': message_def.response.type} + ref = message_def.response.ref + if ref: + provides[name] = ref + responses['keys'] = keys + responses['to_list'] = to_list + responses['to_dict'] = True + responses['provides'] = provides + return responses + + +def _getoptions_from_yml(message_def, + version, + optiondescriptions, + file_path, + needs, + select_option, + load_shortarg): + if message_def.pattern == 'event' and message_def.response: + raise Exception('event with response?: {}'.format(file_path)) + if message_def.pattern == 'rpc' and not message_def.response: + print('rpc without response?: {}'.format(file_path)) + options = [] + # options = [StrOption('version', + # 'version', + # version, + # properties=frozenset(['hidden']))] + _parse_args(message_def, options, file_path, needs, select_option, message_def.uri, load_shortarg) + name = message_def.uri + description = message_def.description.strip().rstrip() + optiondescriptions[name] = (description, options) + + +def _get_root_option(select_option, optiondescriptions): + """get root option + """ + def _get_od(curr_ods): + options = [] + for name in curr_ods.keys(): + if name is None: + description, curr_options = curr_ods[name] + options.extend(curr_ods[name][1]) + else: + if None in curr_ods[name].keys(): + description = curr_ods[name][None][0] + if description.endswith('.'): + description = description[:-1] + else: + description = None + od = OptionDescription(name, + description, + _get_od(curr_ods[name])) + if None in list(curr_ods[name].keys()): + od.impl_set_group_type(groups.message) + options.append(od) + return options + + options_obj = [select_option] + struct_od = {} + for od_name, options_descr in optiondescriptions.items(): + # od_name is something like config.configuration.server.get + curr_od = struct_od + for subod in od_name.split('.'): + curr_od.setdefault(subod, {}) + curr_od = curr_od[subod] + # curr_od is now {'config': {'configuration': {server: {}}}} + curr_od[None] = options_descr + # curr_od is now {'config': {'configuration': {server: {None: options_descr}}}} + options_obj.extend(_get_od(struct_od)) + return OptionDescription('root', 'root', options_obj) + + +def get_messages(load_shortarg=False, only_public=False): + """generate description from yml files + """ + optiondescriptions = OrderedDict() + optiondescriptions_name = [] + optiondescriptions_info = {} + responses = OrderedDict() + needs = OrderedDict() + messages = list(list_messages()) + messages.sort() + for message_name in messages: + message_def = get_message(message_name) + if message_def.pattern not in ['rpc', 'event'] or \ + (not message_def.public and only_public): + continue + optiondescriptions_name.append(message_def.uri) + optiondescriptions_name.sort() + select_option = ChoiceOption('message', + 'Nom du message.', + tuple(optiondescriptions_name), + properties=frozenset(['mandatory', 'positional'])) + for message_name in messages: + message_def = get_message(message_name) + if message_def.pattern not in ['rpc', 'event'] or \ + (not message_def.public and only_public): + continue + optiondescriptions_info[message_def.uri] = message_def.public + version = message_name.split('.')[0] + if message_def.uri in responses: + raise Exception('uri {} allready loader'.format(message_def.uri)) + _getoptions_from_yml(message_def, + version, + optiondescriptions, + message_name, + needs, + select_option, + load_shortarg) + responses[message_def.uri] = _parse_responses(message_def, + message_name) + + root = _get_root_option(select_option, optiondescriptions) + try: + config = Config(root) + except Exception as err: + raise Exception('error when generating root optiondescription: {}'.format(err)) + + config.property.read_write() + # config.property.add('demoting_error_warning') + # return needs, responses, config + return optiondescriptions_info, root diff --git a/src/risotto/services/__init__.py b/src/risotto/services/__init__.py new file mode 100644 index 0000000..2c0f6cc --- /dev/null +++ b/src/risotto/services/__init__.py @@ -0,0 +1,18 @@ +from os import listdir +from os.path import isdir, isfile, dirname, abspath, basename, join +from importlib import import_module +from ..dispatcher import dispatcher + + +def list_import(): + abs_here = dirname(abspath(__file__)) + here = basename(abs_here) + module = basename(dirname(abs_here)) + for filename in listdir(abs_here): + absfilename = join(abs_here, filename) + if isdir(absfilename) and isfile(join(absfilename, '__init__.py')): + dispatcher.set_module(filename, import_module(f'.{here}.{filename}', module)) + dispatcher.validate() + + +list_import() diff --git a/src/risotto/services/config/__init__.py b/src/risotto/services/config/__init__.py new file mode 100644 index 0000000..39ba47e --- /dev/null +++ b/src/risotto/services/config/__init__.py @@ -0,0 +1 @@ +from .config import Risotto diff --git a/src/risotto/services/config/config.py b/src/risotto/services/config/config.py new file mode 100644 index 0000000..ce38696 --- /dev/null +++ b/src/risotto/services/config/config.py @@ -0,0 +1,25 @@ +from ...controller import Controller +from ...dispatcher import register + + +class Risotto(Controller): + # @register('v1.config.created') + async def server_created(self, serverid, servername, servermodelid): + print('pouet') + + @register('v1.config.session.server.start', None) + async def get_configuration(self, risotto_context, id): + stop = await self.call('v1.config.session.server.stop', risotto_context, sessionid=str(id)) + return {'start': id} + + @register('v1.config.session.server.stop', None) + async def get_configuration2(self, sessionid, save): + return {'stop': sessionid} + + @register('v1.config.configuration.server.get', None) + async def get_configuration3(self, server_id, deploy): + return {'get': server_id} + + @register('v1.config.configuration.server.deploy', None) + async def get_configuration4(self, server_id): + return {'deploy': server_id} diff --git a/src/risotto/utils.py b/src/risotto/utils.py new file mode 100644 index 0000000..7282708 --- /dev/null +++ b/src/risotto/utils.py @@ -0,0 +1,9 @@ +class Undefined: + pass + + +def _(s): + return s + + +undefined = Undefined()