Commit 68f9c2e3 authored by lukas.burgey's avatar lukas.burgey

Update README

parent 020102d8
FEUDAL Scripts v2
FEUDAL Scripts Version 3
=
FEUDAL scripts (sometimes also called adapters) are executed by a [feudalClient](https://git.scc.kit.edu/feudal/feudalClient) to facilitate the customized deployment process
of a service.
FEUDAL scripts (also called adapters) are used to deploy feudal users in a customizable fashion. They are executed by a [feudalClient](https://git.scc.kit.edu/feudal/feudalClient).
The scripts use the JSON encoding for input and output. The specific formats are loosely outlined below.
The input is passed to the scripts via stdin.
This library can be used as a starting point to implement such a script.
Examples can be found here: [a simple stub](stubScript), [creating SSH access](sshScript), and [handling questionnaires](questionnaireScript)
The [feudalClient](https://git.scc.kit.edu/feudal/feudalClient) can be used to generate and validate JSON schema for input
The scripts use json for input and output. The specific formats are loosely
outlined below. The input is passed to the scripts via stdin.
The [feudalClient](https://git.scc.kit.edu/feudal/feudalClient) can be used to generate and validate json schema for input
and output, see:
```
feudalClient schema --help
feudalClient validate --help
```
Input Format of v2
Input Format
-
```
{
......@@ -44,13 +46,17 @@ Input Format of v2
// Answers to a previously requested questionnaire, may not be present
"answers": {
"question_name": "user answer to this question"
"question_name": "user answer to this question",
"age_question": 18,
"list_question": "person_a",
"list_question_2": 2,
"are_you_sure": true
}
}
```
Output Format of v2
Output Format
-
```
{
......@@ -70,7 +76,21 @@ Output Format of v2
// questions in this dictionary.
// The user can answer these questions (and we will receive the answers some input in the future)
"questionnaire": {
"question_name": "question"
"question_name": "question",
"age_question": "How old are you?",
"list_question": "Who are you?",
"list_question_2": "How many do you want?",
"are_you_sure": "What you are trying is wrong. Are you sure?"
},
// By default questions in questionnaire expect answers are strings. You can change this here:
// Add a mapping with the same key here
"questionnaire_answers": {
"question_name": "question", // string default value
"age_question": 18, // age_question must be an integer, defaulting to 18
"list_question": ["person_a", "person_b"], // list_question must be one of the listed options
"list_question_2": [1, 2], // list_question_2 must be one of the listed options
"are_you_sure": false // are_you_sure must be a boolean, with false being the default value
},
// additional credentials and instructions, the user needs to access the service (in addition to her credentials from the Input)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment