add jx example
This commit is contained in:
parent
4eb3a9d2a7
commit
1fdc1fc456
29
README.md
29
README.md
@ -10,7 +10,34 @@ These tools work with YAML descriptions of resources (E.g. files, users, contain
|
||||
|
||||
# Releases
|
||||
|
||||
v0 releases are unstable and changes may be made to interfaces and specifications.
|
||||
**v0 releases are unstable and changes may be made to interfaces and specifications.**
|
||||
|
||||
# JX Documents
|
||||
|
||||
The JX YAML specification is a simple way to describe system resources. The two main components are `configurations` and `resources`.
|
||||
|
||||
## Configurations
|
||||
|
||||
`
|
||||
configurations:
|
||||
- name: myhttpconfig
|
||||
values:
|
||||
http_user: jex
|
||||
http_password: sample
|
||||
- name: myhttptoken
|
||||
values:
|
||||
authorization_token: abcde123456789
|
||||
`
|
||||
|
||||
## Resources
|
||||
`
|
||||
resources:
|
||||
- type: http
|
||||
config: myhttptoken
|
||||
transition: read
|
||||
attributes:
|
||||
endpoint: https://myserver/v1/api
|
||||
`
|
||||
|
||||
# Testing
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user