akillibulut/coriolis-web: Cloud Migration Web UI @ 3df3ed01d4c732ae57f33b50e7618921928eae19

Cloud Migration Web UI

Sergiu Miclea 3df3ed01d4 Upgrade Yarn to modern (3.6.3) version		%!s(int64=2) %!d(string=hai) anos
.github	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	%!s(int64=2) %!d(string=hai) anos
.storybook	4a7432971b Add unit tests	%!s(int64=4) %!d(string=hai) anos
.vscode	3dc8fa6372 Revamp the entire source code style and formatting	%!s(int64=3) %!d(string=hai) anos
.yarn	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	%!s(int64=2) %!d(string=hai) anos
private	16bf1eb6fb Add Jest unit testing framework	%!s(int64=4) %!d(string=hai) anos
public	2c6427f7d1 Move typing system from 'flow' to 'typescript'	%!s(int64=5) %!d(string=hai) anos
server	7fb6073cf6 Add LXD provider logo variants and label	%!s(int64=2) %!d(string=hai) anos
src	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	%!s(int64=2) %!d(string=hai) anos
tests	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	%!s(int64=2) %!d(string=hai) anos
.dockerignore	007b40e2e5 Docker file upgrade Node version from 16 to 18	%!s(int64=2) %!d(string=hai) anos
.editorconfig	0d39a85837 Coriolis with Atomic design implementation	%!s(int64=8) %!d(string=hai) anos
.eslintrc.js	3dc8fa6372 Revamp the entire source code style and formatting	%!s(int64=3) %!d(string=hai) anos
.gitignore	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	%!s(int64=2) %!d(string=hai) anos
.prettierrc	3dc8fa6372 Revamp the entire source code style and formatting	%!s(int64=3) %!d(string=hai) anos
.yarnrc.yml	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	%!s(int64=2) %!d(string=hai) anos
Dockerfile	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	%!s(int64=2) %!d(string=hai) anos
LICENSE	0d39a85837 Coriolis with Atomic design implementation	%!s(int64=8) %!d(string=hai) anos
README.md	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	%!s(int64=2) %!d(string=hai) anos
babel.config.js	faccd2bdc3 Apply the new code style changes to root files	%!s(int64=3) %!d(string=hai) anos
config.ts	7fb6073cf6 Add LXD provider logo variants and label	%!s(int64=2) %!d(string=hai) anos
cypress.json	32b0c10d24 Increased requestTimeout to 10s	%!s(int64=7) %!d(string=hai) anos
jest.config.ts	faccd2bdc3 Apply the new code style changes to root files	%!s(int64=3) %!d(string=hai) anos
package.json	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	%!s(int64=2) %!d(string=hai) anos
tsconfig.json	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	%!s(int64=2) %!d(string=hai) anos
ui-mod-sample.json	257c052529 Add ability to set services URLs using MOD_JSON	%!s(int64=6) %!d(string=hai) anos
webpack.common.js	faccd2bdc3 Apply the new code style changes to root files	%!s(int64=3) %!d(string=hai) anos
webpack.dev.js	faccd2bdc3 Apply the new code style changes to root files	%!s(int64=3) %!d(string=hai) anos
webpack.prod.js	faccd2bdc3 Apply the new code style changes to root files	%!s(int64=3) %!d(string=hai) anos
yarn.lock	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	%!s(int64=2) %!d(string=hai) anos

Web GUI for coriolis

Install instructions

Install Node 18
clone repo
run corepack enable for yarn 3 support
run yarn install (development deps) or yarn workspaces focus --all --production (production deps)
set CORIOLIS_URL environment variable

Build instructions

Build the production version of the UI:

run npm run build
run npm run start to start the server

Your server will be running at http://localhost:3000/ (the port is configurable through PORT environment variable)

Testing

unit tests can be run using npm run test
run npm run test-release to check for Typescript, ESLint and prettier errors. This will also run the unit tests and will try to build and start a production version. If eeverything is OK, it will revert to the development installation.

Development mode

set env. variable NODE_ENV='development'
run npm run client-dev to start local development server (starts on port 3001)
run npm run server-dev to start the express server in development mode

To debug the client code using VS Code, simply run the project's launch configuration from the 'Run' menu (Ctrl+Shift+D). The last 2 npm run ... commands must be running in the background.

To debug the Node server using VS Code, run npm run server-debug instead of npm run server-dev.

You can view some of the UIs components in the Storybook by running npm run storybook

Modding

The UI can be modded externally using a .json modding file. A sample is available in the repo ui-mod-sample.json.

The path to the .json mod file needs to be set in MOD_JSON environment variable (ex.: MOD_JSON=/usr/ui-mod.json).

Any provider logos can be replaced using local logo images. The local image file paths need to be absolute.

You can specify one logo, in which case it will be scaled to all sizes. You can also specify logos for just a couple of the sizes, in which case the closest size to the one required will be used. Open ui-mod-sample.json for more details.

Any option from config.ts can be modified by adding the config field to the ui-mod-sample.json file.

Environment variables

All environment variables can be set in a .env file created in the root directory.

The following is the list of environment variables and their default values:

NODE_ENV='production'
CORIOLIS_URL='<your-coriolis-url>'
MOD_JSON='<path-to-json>'
CA_FINGERPRINT='<path to CA fingerprint file used by metal hub agent>'

README.md