add jx example
Some checks are pending
Lint / golangci-lint (push) Waiting to run
Declarative Tests / test (push) Waiting to run
Declarative Tests / build-fedora (push) Waiting to run
Declarative Tests / build-ubuntu-focal (push) Waiting to run

This commit is contained in:
Matthew Rich 2024-09-23 17:03:20 +00:00
parent 4eb3a9d2a7
commit 1fdc1fc456

View File

@ -10,7 +10,34 @@ These tools work with YAML descriptions of resources (E.g. files, users, contain
# Releases # 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 # Testing