Console is a web-based UI for managing resources within Kyma. It consists of separate front-end applications. Each project is responsible for providing a user interface for particular resource management.
The Console project consists of the following UI projects:
Core- The main frame of Kyma UICatalog- The UI layer for Service CatalogInstances- The view for displaying Service InstancesBrokers- The view for displaying Service BrokersAddons- The view for displaying Namespace-scoped and cluster-wide AddonsLambda- The view for lambda functionsContent- The documentation viewLog UI- The logs viewCompass- The experimental view for the Compass project.Tests- Acceptance and end-to-end tests
The Console also includes React and Angular libraries:
React common- common functionalities for React applicationsReact components- components for React applications (it will be replaced byShared components)Shared components- new versions of components for React applications written in TypeScriptGeneric documentation- a React component that uses@kyma-project/documentation-componentfor displaying documentation and various specifications in theContent,CatalogandInstancesviews.
-
Install Kyma as a backing service for your local instance of Console. Make sure you import certificates into your operating system and mark them as trusted. Otherwise, you cannot access the applications hosted in the
kyma.localdomain. -
Install Console dependencies. To install dependencies for the root and all UI projects, and prepare symlinks for local libraries within this repository, run the following command:
npm run bootstrap
NOTE: The
npm run bootstrapcommand:- installs root dependencies provided in the package.json file
- installs dependencies for the
React common,React components,Shared componentsandGeneric documentationlibraries - builds all the libraries
- installs dependencies for all the components
- updates your
/etc/hostswith the127.0.0.1 console-dev.kyma.localhost - ignores all
config.jsfiles in git
Use the following command to run the Console with the core and all other views locally:
npm run startTo access the local instance of the Console at http://console-dev.kyma.local:4200, use credentials from this document - point 3.
If you want to watch changes in the React libraries, run the following command in a new terminal window:
npm run watch:librariesOnce you start Kyma with Console locally, you can start development. All modules have hot-reload enabled therefore you can edit the code real time and see the changes in your browser.
The Core and other UIs run at the following addresses:
Core- http://console-dev.kyma.local:4200Lambda- http://console-dev.kyma.local:4201Log UI- http://console-dev.kyma.local:4400Catalog- http://console-dev.kyma.local:8000Instances- http://console-dev.kyma.local:8001Brokers- http://console-dev.kyma.local:8002Content- http://console-dev.kyma.local:8003Addons- http://console-dev.kyma.local:8004
If you want to run only a specific UI, follow the instructions in the appropriate folder.
By default, the core and all other views are connected to the GraphQL API running on the cluster at this address. If you want to use local GraphQL API endpoint, follow the instructions in the Run a local version section of this document and run the following command:
npm run start:apiFor the information on how to run tests and configure them, go to the tests directory.
TIP: To solve most of the problems with the Console development, clear the browser cache or do a hard refresh of the website.
Remove the node_modules folder and the package-lock.json file in all libraries in the components folder and on the root. Then rerun the npm run bootstrap command in the root context and push all the changes.
Can't access console.kyma.local and console-dev.kyma.local:4200 after hibernating the Minikube cluster
Follow the guidelines from this document to solve the problem.