Eclipse Che is a next generation Eclipse IDE. This repository is licensed under the Eclipse Public License 2.0. Visit Eclipse Che's Web site for feature information or the main Che assembly repository for a description of all participating repositories.
- Node.js
v14
and later. - yarn
v1.20.0
or higher.
Note: Below you can find installation instructions
docker build . -f build/dockerfiles/Dockerfile -t quay.io/eclipse/che-dashboard:next
To run Dashboard against Che Cluster you need access to Kubernetes cluster where it lives. So, make sure kubeconfig from $KUBECONFIG (or if unset ~/.kube/config) has the target cluster as current. If no - you may need to do oc login (if it's OpenShift) or modify it manually if it's Kubernetes. Then you can proceed to the following steps:
# 1. Install all dependencies:
yarn
# 2. Patch cluster to enable local development flow:
yarn start:prepare
# 3. Run server locally:
yarn start
# 4. (optional) Patch cluster to revert it to initial state:
yarn start:cleanup
# If you want to make sure the latest bits are used, add flag to recompile
# yarn start --force-build
# Optionally you may need to set CHE_NAMESPACE where CheCluster CR live
# which is eclipse-che by default
# export CHE_NAMESPACE="my-custom-che"
The development server serves the dashboard-frontend and dashboard-backend on http://localhost:8080.
- Native Auth:
With Native Auth, routes are secured with OpenShift OAuth which we can't deal with easily.
So, instead when you do
yarn start
we bypass OpenShift OAuth proxy while requesting Che Server by doingkubectl port-forward
. So, no additional configuration is needed but note that your Dashboard will be authentication with the user from the current KUBECONFIG.
You may would like to watch changes and recompile them incrementally:
yarn --cwd packages/dashboard-backend build:watch
yarn --cwd packages/dashboard-frontend build:watch
As an alternative to build:watch for frontend, you can run Dev Server.
Local backend is prerequisite for Dev Server and then the command to run Dev Server is
yarn frontend:start
To avoid memory issues and the process being killed, more memory is possible through the following command in the frontend package directory:
NODE_OPTIONS="--max_old_space_size=6500" && yarn frontend:start
To make sure all the dependencies satisfy Eclipse Intellectual Property, this repo uses https://github.com/che-incubator/dash-licenses which is a wrapper for https://github.com/eclipse/dash-licenses.
So, check .deps/prod.md for dependencies we package and .deps/dev.md for ones we use at build time only.
To generate dependencies info:
yarn license:generate
Default branding data for the User Dashboard is located in branding.constant.ts#BRANDING_DEFAULT. It can be overridden without re-building the project in product.json file which should contain only values that should overwrite default ones.
Field "header.warning"
allows you to display a message at the top of the dashboard. You can use HTML to configure the field but only the '<a>' tag and 'href', 'target' properties are accepted. It's undefined by default.
Example:
{
"header": {
"warning": "Server upgrades are happening at 1:00 PM. To learn more visit <a href='foo' target='_blank'>foo</a>"
}
}
Field "links"
allows you to configure links in the masthead, like
links: [
{
text: 'Make a wish',
href: 'mailto:che-dev@eclipse.org'
},
{
text: 'Documentation',
href: 'https://www.eclipse.org/che/docs/che-7'
}
]
The Dashboard has the ability to provide the way to navigate to the OpenShift cluster console via the Applications
menu that is shown in the Dashboard masthead.
This ability can be tunned by setting the environment variables:
Env var | Description | Default value |
---|---|---|
OPENSHIFT_CONSOLE_GROUP | The group title where Console link is shown | Applications |
OPENSHIFT_CONSOLE_TITLE | The title that is displayed near icon. Set to "" to hide that Console Link at all. | OpenShift Console |
OPENSHIFT_CONSOLE_ICON | The icon that is used for the link | ${CONSOLE_URL}/static/assets/redhat.png |
The following example shows how to provision that env vars with Che Operator:
CHE_NAMESPACE="eclipse-che"
cat <<EOF | kubectl apply -f -
kind: ConfigMap
apiVersion: v1
metadata:
name: che-dashboard-custom-config
namespace: eclipse-che
labels:
app.kubernetes.io/component: che-dashboard-configmap
app.kubernetes.io/part-of: che.eclipse.org
annotations:
che.eclipse.org/OPENSHIFT_CONSOLE_GROUP_env-name: OPENSHIFT_CONSOLE_GROUP
che.eclipse.org/OPENSHIFT_CONSOLE_TITLE_env-name: OPENSHIFT_CONSOLE_TITLE
che.eclipse.org/OPENSHIFT_CONSOLE_ICON_env-name: OPENSHIFT_CONSOLE_ICON
che.eclipse.org/mount-as: env
data:
OPENSHIFT_CONSOLE_GROUP: Apps
OPENSHIFT_CONSOLE_TITLE: OpenShift Container Platform
OPENSHIFT_CONSOLE_ICON: https://example.com/icon.png
EOF
# Due temporary limitation we need to rollout che operator to apply changes
kubectl rollout restart deployment/che-operator -n $CHE_NAMESPACE
Note: This way to configure dashboard is experimental and may be changed.
Che is open sourced under the Eclipse Public License 2.0.