Provision resources using a declarative YAML syntax.

Go to file

Matthew Rich 2bee7f6bea Some checks failed Lint / golangci-lint (push) Has been cancelled Details Declarative Tests / test (push) Has been cancelled Details Declarative Tests / build-fedora (push) Has been cancelled Details Declarative Tests / build-ubuntu-focal (push) Has been cancelled Details update cli tests		2024-09-25 05:13:53 +00:00
.gitea/workflows	add build step in fedora job	2024-05-29 00:25:29 -07:00
artifacts	generate coverage report	2024-03-23 13:03:42 -07:00
build	fix package rpmbuild name	2024-05-26 15:57:23 -07:00
cmd/cli	use client package in jx cli	2024-09-25 05:03:50 +00:00
examples	Fix an issue with the package resource where a missing package would cause a fatal error	2024-07-22 15:03:22 -07:00
internal	update cli tests	2024-09-25 05:13:53 +00:00
md-images	add jx-import doc	2024-05-09 01:50:56 -07:00
tests/mocks	update cli tests	2024-09-25 05:13:53 +00:00
.gitignore	Initial commit	2024-03-09 00:12:54 +00:00
cli_test.go	update cli tests	2024-09-25 05:13:53 +00:00
COPYRIGHT	initial version	2024-03-20 12:23:31 -07:00
go.mod	Fix an issue with the package resource where a missing package would cause a fatal error	2024-07-22 15:03:22 -07:00
go.sum	add support for RSA keys/certs	2024-07-17 01:34:57 -07:00
LICENSE	initial version	2024-03-20 11:56:28 -07:00
Makefile	Fix an issue with the package resource where a missing package would cause a fatal error	2024-07-22 15:03:22 -07:00
README.md	fix formatting	2024-09-23 17:05:25 +00:00

README.md

jx

Purpose

These tools work with YAML descriptions of resources (E.g. files, users, containers, etc) for (de)serializing the state of the given resource. This enables more generically describing the state of a supported resource type, pipeling state transformations and enabling the use of other tools in that process.

Dependencies

Go >= 1.21.1

Releases

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 the current version involves checking out main and building.

git clone https://gitea.rosskeen.house/doublejynx/jx.git

make test

make build

Command-line

Update Resource state

jx apply decl-runner.yaml

Create the resources specified in a resource document HTTP endpoint.

jx apply http://localhost/resources

Convert a tar archive into resource definitions and apply them (extracts the contents of a tar).

jx apply https://gitea.rosskeen.house/doublejynx/jx/archive/v0.2.1.tar.gz

Read resource state

Read the state of an existing resource (URI) and generate a YAML representation of it.

jx import -resource file://COPYRIGHT

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.

Import system packages using the debian package type, and output the resource documents in JSON format.

jx import --output json:// package://?type=deb

Import the contents of a tar archive into a resource document.

jx import ./test.tgz

Import resource documents from multiple sources.

jx import repo/packages/build.jx.yaml ./gopkgs.tar.gz

Read a resource document from an http endpoint.

jx import http://localhost/resources

Diff resource documents

Examples

Resources: