Skip to content

cozystack/openapi-ui

 
 

Repository files navigation

openapi-ui

React + TypeScript UI for Kubernetes

A React + TypeScript app that provides tables, forms and factories that renders UI and data directly from Kubernetes Custom Resources (CRDs). Define interfaces in YAML; the app discovers CRDs, watches their objects, and builds a live UI.

⚙️ Configuration

This app can be configured through environment variables.

Variable Type Description
BASEPREFIX string Base URL for the app. /openapi-ui
KUBE_API_URL string URL for the Kubernetes API. http://api.incloud-web.svc.default.in-cloud.internal:8081
BFF_URL string URL for the BFF
LOGIN_URL string Login endpoint. /oauth/token
LOGOUT_URL string Logout endpoint. /oauth/logout
LOGIN_USERNAME_FIELD string Field from login endpoint response. name
CUSTOMIZATION_API_GROUP string API group for customization resources. front.in-cloud.io
CUSTOMIZATION_API_VERSION string API version for customization resources. v1alpha1
CUSTOMIZATION_NAVIGATION_RESOURCE_NAME string Resource plural name for navigation settings. navigations
CUSTOMIZATION_NAVIGATION_RESOURCE string Resource name for navigation settings. navigation
USE_NAMESPACE_NAV boolean Use namespaces instead of project/instances. true
NAVIGATE_FROM_CLUSTERLIST string Location to be navigated after selecting cluster. /openapi-ui/clusters/~recordValue~
PROJECTS_API_GROUP string API group for projects resources. If not using namespace nav.
PROJECTS_VERSION string API version for projects resources. If not using namespace nav.
PROJECTS_RESOURCE_NAME string Plural name for projects resources. If not using namespace nav.
INSTANCES_API_GROUP string API group for instances resources. If not using namespace nav.
INSTANCES_VERSION string API version for instances resources. If not using namespace nav.
INSTANCES_RESOURCE_NAME string Plural name for instances resources. If not using namespace nav.
MARKETPLACE_RESOURCE_NAME string Plural name for marketplace resources for related factory component.
MARKETPLACE_KIND string Kind name for marketplace resources for related factory component.
NODE_TERMINAL_DEFAULT_PROFILE string Default profile for node terminal component. baseline
REMOVE_BACKLINK boolean Remove backlink arrow from right-side navigation
REMOVE_BACKLINK_TEXT boolean Remove backlink text from right-side navigation
DOCS_URL string URL to navigate from question mark

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 99.4%
  • Other 0.6%