notebooks/components/crud-web-apps/volumes
Orfeas Kourkakis dfadbec6e1 vwa: Update cluster role to list notebooks (kubeflow/kubeflow#6808)
Update manifests for volumes-web-app-cluster-role to be able to list
notebooks in kubeflow.org.

Signed-off-by: Orfeas Kourkakis <orfeas@arrikto.com>

Signed-off-by: Orfeas Kourkakis <orfeas@arrikto.com>
2022-12-07 17:04:37 +00:00
..
backend vwa: Add EVENTS tab to Volume details page (kubeflow/kubeflow#6806) 2022-12-07 16:58:37 +00:00
frontend vwa: Add EVENTS tab to Volume details page (kubeflow/kubeflow#6806) 2022-12-07 16:58:37 +00:00
manifests vwa: Update cluster role to list notebooks (kubeflow/kubeflow#6808) 2022-12-07 17:04:37 +00:00
.gitignore Volumes Management UI (kubeflow/kubeflow#5684) 2021-03-18 01:07:16 -07:00
Dockerfile updated compatible base images & removed arch dependencies in different components for multiple arch support (kubeflow/kubeflow#6650) 2022-11-23 13:42:42 +00:00
Makefile Adding support for linux-ppc64le in CI to release multi-arch docker image volumes-web-app (kubeflow/kubeflow#6811) 2022-12-07 16:59:36 +00:00
README.md Fix legacy of Python version information in README files. (kubeflow/kubeflow#6561) 2022-07-25 12:13:13 +00:00

README.md

Volumes web app

This web app is responsible for allowing the user to manipulate PVCs in their Kubeflow cluster. To achieve this it provides a user friendly way to handle the lifecycle of PVC objects.

Development

Requirements:

  • node 12.0.0
  • python 3.8

Frontend

# build the common library
cd components/crud-web-apps/common/frontend/kubeflow-common-lib
npm i
npm run build
cd dist/kubeflow
npm link

# build the app frontend
cd ../../../volumes/frontend
npm i
npm link kubeflow
npm run build:watch

Backend

# create a virtual env and install deps
# https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/
cd component/crud-web-apps/volumes/backend
python3.8 -m pip install --user virtualenv
python3.8 -m venv web-apps-dev
source web-apps-dev/bin/activate

# install the deps on the activated virtual env
make -C backend install-deps

# run the backend
make -C backend run-dev

internationalization

support for non-english languages is only supported in a best effort way.

internationalization(i18n) was implemented using angular's i18n guide and practices, in the frontend. you can use the following methods to ensure the text of the app will be localized:

  1. i18n attribute in html elements, if the node's text should be translated
  2. i18n-{attribute} in an html element, if the element's attribute should be translated
  3. $localize to mark text in typescript variables that should be translated

the file for the english text is located under i18n/messages.xlf and other languages under their respective locale folder, i.e. i18n/fr/messages.fr.xfl. each language's folder, aside from english, should have a distinct and up to date owners file that reflects the maintainers of that language.

testing

you can run a different translation of the app, locally, by running

ng serve --configuration=fr

you must also ensure that the backend is running, since angular's dev server will be proxying request to the backend at localhost:5000.