krateoplatformops/krateo-bff

Krateo Backend For Frontend

Krateo BFF

Krateo Backend For Frontend.

CardTemplate API

List all card templates

Verb	GET
Path	/apis/widgets.ui.krateo.io/cardtemplates
Query Params	sub: username (subject)
	orgs: comma separated organizations
	namespace: namespace where to list cardtemplates (optional)
	version: cardtemplates schema version (optional)

Example

curl "http://localhost:8090/apis/widgets.ui.krateo.io/cardtemplates?sub=cyberjoker&orgs=devs&namespace=demo-system"

Get one card template

Method	GET
Path	/apis/widgets.ui.krateo.io/cardtemplates/${NAME}
Path Params	${NAME} is your CardTemplate object name
Query Params	sub: username (subject)
	orgs: comma separated organizations
	namespace: namespace where to list cardtemplates
	version: cardtemplates schema version (optional)

Example:

curl "http://localhost:8090/apis/widgets.ui.krateo.io/cardtemplates/one?sub=cyberjoker&orgs=devs&namespace=demo-system"

Column API

List all columns

Verb	GET
Path	/apis/layout.ui.krateo.io/columns
Query Params	sub: username (subject)
	orgs: comma separated organizations
	namespace: namespace where to list cardtemplates (optional)
	version: cardtemplates schema version (optional)

Example:

curl "http://localhost:8090/apis/layout.ui.krateo.io/columns?sub=cyberjoker&orgs=devs&namespace=demo-system"

Get one column

Method	GET
Path	/apis/layout.ui.krateo.io/columns/${NAME}
Path Params	${NAME} is your Column object name
Query Params	sub: username (subject)
	orgs: comma separated organizations
	namespace: namespace where to list cardtemplates
	version: cardtemplates schema version (optional)

Example:

curl "http://localhost:8090/apis/layout.ui.krateo.io/columns/three?sub=cyberjoker&orgs=devs&namespace=demo-system"

Rows API

List all rows

Verb	GET
Path	/apis/layout.ui.krateo.io/rows
Query Params	sub: username (subject)
	orgs: comma separated organizations
	namespace: namespace where to list cardtemplates (optional)
	version: cardtemplates schema version (optional)

Example:

curl "http://localhost:8090/apis/layout.ui.krateo.io/rows?sub=cyberjoker&orgs=devs&namespace=demo-system"

Get one row

Method	GET
Path	/apis/layout.ui.krateo.io/rows/${NAME}
Path Params	${NAME} is your Row object name
Query Params	sub: username (subject)
	orgs: comma separated organizations
	namespace: namespace where to list cardtemplates
	version: cardtemplates schema version (optional)

Example:

curl "http://localhost:8090/apis/layout.ui.krateo.io/rows/two?sub=cyberjoker&orgs=devs&namespace=demo-system"

FormTemplate API

List all rows

Verb	GET
Path	/apis/widgets.ui.krateo.io/formtemplates
Query Params	sub: username (subject)
	orgs: comma separated organizations
	namespace: namespace where to list cardtemplates (optional)
	version: cardtemplates schema version (optional)

Example:

curl "http://localhost:8090/apis/widgets.ui.krateo.io/formtemplates?sub=cyberjoker&orgs=devs&namespace=demo-system"

Get one formtemplate

Method	GET
Path	/apis/widgets.ui.krateo.io/formtemplates/${NAME}
Path Params	${NAME} is your Row object name
Query Params	sub: username (subject)
	orgs: comma separated organizations
	namespace: namespace where to list cardtemplates
	version: cardtemplates schema version (optional)

Example:

curl "http://localhost:8090/apis/widgets.ui.krateo.io/formtemplates/fireworksapp?sub=cyberjoker&orgs=devs&namespace=demo-system"

Apps API

Create or Update an App

Method	POST
Path	/apis/apps/${NAME}
Path Params	${NAME} is your "app" object name
Query Params	sub: username (subject)
	orgs: comma separated organizations
	namespace: namespace where your "app" resource belongs
	group: api group of your custom "app" resource
	kind: kind of your "app" resource
	version: api schema version of your "app" resource (optional)

Example:

curl -X POST -H "Content-Type: application/json" \
    --data @fireworksapp.json \
    "http://localhost:8090/apis/apps/fireworksapp?sub=cyberjoker&orgs=devs&kind=Fireworksapp&group=composition.krateo.io&namespace=demo-system"

krateo-bff's Issues

Remove FormTemplate

API skipped when has no dependencies

Dump env vars

Dump all environment variables when the debug flag it's true.

Remove name and namespace from formtemplate action

Compressed YAML

FomTemplate has a data section that is an array of (yaml path, value) pairs. Those values must be merged with the existing CR(d) spec values.

Handle CompositionDefinition

Ignore missing cards when build rows

Upgrade dockerfile

Bind Cardtemplate to FormTemplate

Actions for card Iterator

Replace cardtemplate GET action

Add CORS Middleware

form template

Create a new endpoint capable of managing custom FormTemplate resources.

Helper method to apply generic resources

Inject schema metadata

Missed resources kind in actions

List FormTemplates

Create an endpoint to return the list of all FormTemplates in a namespace

Change formtemplates action url

Fix FormtemplateRef resolution

Actions Handler

Manage FormTemplate Ref Resource

Handle Service Port Env

Some tools such as vluster set the environment variable relating to the port on which the service must listen in the format tcp://IP:PORT rather than just PORT.