doublejynx/jx
doublejynx/jx
1
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases 7 Wiki Activity

remove out-of-date doc image
Some checks failed
Lint / golangci-lint (push) Successful in 9m49s
Details
Declarative Tests / test (push) Failing after 14s
Details
Declarative Tests / build-fedora (push) Successful in 2m10s
Details
Declarative Tests / build-ubuntu-focal (push) Successful in 1m13s
Details

Browse Source
This commit is contained in:
Matthew Rich 2024-07-08 10:06:07 -07:00
parent 88be30485f
commit 2c1e1de7d1
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -8,6 +8,10 @@ These tools work with YAML descriptions of resources (E.g. files, users, contain
* Go >= 1.21.1
# Releases
v0 releases are unstable and changes may be made to interfaces and specifications.
# Testing
Testing the current version involves checking out main and building.
@ -40,8 +44,6 @@ Read the state of an existing resource (URI) and generate a YAML representation
`jx import -resource file://COPYRIGHT`
![Import Resource](md-images/import-resource.gif)
## Importing resources from different sources
JX supports importing resources data from various source types, among these are filesystem directories, tar archive contents, containers, iptables chains, installed packages, etc.
@ -72,9 +74,13 @@ Read a resource document from an http endpoint.
Resources:
* [file](examples/file.yaml) [schema](internal/resource/schemas/file.jsonschema)
* [http](examples/http.yaml) [schema](internal/resource/schemas/http.jsonschema)
* [user](examples/user.yaml) [schema](internal/resource/schemas/user.jsonschema)
* [package](examples/package.yaml) [schema](internal/resource/schemas/package.jsonschema)
* [container](examples/container.yaml) [schema](internal/resource/schemas/container.jsonschema)
* [network_route](examples/network_route.yaml) [schema](internal/resource/schemas/network_route.jsonschema)
* [container](examples/container.yaml) [schema](internal/resource/schemas/container.schema.json)
* [container-image](examples/container-image.yaml) [schema](internal/resource/schemas/container-image.schema.json)
* [container-network](examples/container-network.yaml) [schema](internal/resource/schemas/container-network.schema.json)
* [exec](examples/exec.yaml) [schema](internal/resource/schemas/exec.schema.json)
* [file](examples/file.yaml) [schema](internal/resource/schemas/file.schema.json)
* [http](examples/http.yaml) [schema](internal/resource/schemas/http.schema.json)
* [iptable](examples/iptable.yaml) [schema](internal/resource/schemas/iptable.schema.json)
* [network_route](examples/network_route.yaml) [schema](internal/resource/schemas/network_route.schema.json)
* [package](examples/package.yaml) [schema](internal/resource/schemas/package.schema.json)
* [user](examples/user.yaml) [schema](internal/resource/schemas/user.schema.json)