Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
10
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Open sidebar
feudal
feudalScripts
Commits
5417d535
Commit
5417d535
authored
Aug 20, 2018
by
ubedv
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update README.md
parent
c5a7fd46
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
18 additions
and
6 deletions
+18
-6
README.md
README.md
+18
-6
No files found.
README.md
View file @
5417d535
...
...
@@ -7,10 +7,14 @@ of an arbitrary service.
They use the JSON encoding for input and output. The specific formats are outlined below.
Input
f
ormat
Input
F
ormat
-
```
{
// The state which is to be reached by this script execution
//
// deployed -> the script is supposed to deploy the user
// not_deployed -> the script is supposed to remove the user
"state_target": "deployed" or "not_deployed",
...
...
@@ -34,13 +38,20 @@ Input format
"question_name": "user answer to this question"
}
}
```
Output format
Output Format
-
```
{
// The state as of now (after the script run)
//
// deployed -> The deployment was processed successfully
// not_deployed -> The removal of the user was processed successfully
// failed -> An error occured and the script could not reach the 'state_target' from the Input
// rejected -> The user is not permitted to use this service, for whatever reason
// questionnaire-> The script needs more information to deploy the user
"state": "deployed" or "not_deployed" or "failed" or "rejected" or "questionnaire",
...
...
@@ -53,9 +64,10 @@ Output format
"question_name": "question"
},
// additional credentials and instructions, the user needs to access the service
// additional credentials and instructions, the user needs to access the service
(in addition to her credentials from the Input)
// an example would be the user name of the provisioned user.
"credentials": {
"key": "value"
}
}
```
\ No newline at end of file
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment