Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Latest commit

 

History

History
167 lines (109 loc) · 7.78 KB

README.md

File metadata and controls

167 lines (109 loc) · 7.78 KB
Raw

⚠️ This repository has been deprecated and will be archived soon. ⚠️

Compass Console

Overview

The Compass Console is a web-based UI for managing resources within Compass.

Components

The Console includes React and Angular libraries:

Prerequisites

  • npm: min. version 6.4.0
  • node: min. version 12.0.0

Installation

  1. Change your current directory to the compass-console/compass directory.

  2. Run the following commands in your terminal:

    npm install
cd ..
npm run bootstrap -- https://{OIDC-PROVIDER-DOMAIN} {OIDC-CLIENT-ID}
cd compass
npm start

    NOTE: The npm run bootstrap command does the following:

    1. Installs root dependencies provided in the package.json file.
    2. Installs dependencies for the React common, React components, Shared components and Generic documentation libraries.
    3. Builds all the libraries.
    4. Installs dependencies for all the components.
    5. Creates the .clusterConfig.gen configuration file if it doesn't exist, pointing at the kyma.local domain.

    NOTE: To skip the OIDC configuration arguments {OIDC-PROVIDER-DOMAIN} and {OIDC-CLIENT-ID}, you can use the npm run bootstrap:compass command instead of the npm run bootstrap -- https://{OIDC-PROVIDER-DOMAIN} {OIDC-CLIENT-ID} command. This way, the npm script tries to get the required values from the ~/.compass.yaml file. To carry out the command, you need the yq tool. The ~/compass.yaml file must have the following structure:

    idpHost: {URL_TO_OIDC_SERVER}

    clientID: {OIDC_CLIENT_ID}

    adminGroupNames: {OIDC_ADMIN_GROUPS}

    Note that the Compass console works properly only when the configuration arguments are passed or the ~.compass.yaml file exists.

  3. As a result, the Compass UI opens in a new tab of your browser. Alternatively, you can go to http://localhost:8080.

Usage

Set the cluster (optional)

By default, the Compass cluster URL, with which the Console communicates, is set to kyma.local. To change the address of the cluster, run:

./scripts/setClusterConfig.sh {CLUSTER_URL} https://{YOUR-OIDC-PROVIDER-DOMAIN} {YOUR-OIDC-CLIENT-ID}

To simplify switching of clusters, hosted on the same domain, you can assign the domain to CLUSTER_HOST environment variable, and then, use any subdomain as a cluster name.

For example, if you want to easily switch between two clusters foo.abc.com and bar.abc.com, run the following commands:

export CLUSTER_HOST=abc.com
# If you use only one domain for your cluster, consider setting it permanently in your shell.

./scripts/setClusterConfig.sh foo
# After setting the CLUSTER_HOST variable this is equal to running ./scripts/.setClusterConfig foo.abc.com

./scripts/setClusterConfig.sh bar
# Switch to a different cluster on the same domain

To reset the domain to the default kyma.local setting, run:

./scripts/setClusterConfig.sh local

Required credentials

To get the credentials required to access the local instance of the Compass Console at http://compass-dev.kyma.local:8080, follow the instructions from this document.

Watch changes in React libraries

If you want to display the changes in the React libraries simultaneously, run the following command in a new terminal window:

npm run watch:libraries

Development

You can start developing as soon as you start the Compass Console locally. All modules have hot-reload enabled, and therefore, you can edit the code in real time and see the changes in your browser.

The Compass Console UI is available at http://localhost:8080 or http://compass-dev.kyma.local:8080.

Security countermeasures

When developing new features in Compass Console UI, adhere to the following rules. This will help you to mitigate any security-related threats.

Prevent Cross-site request forgery (XSRF)

  • Do not store the authentication token as a cookie. Make sure the token is sent to the Console Backend Service as a bearer token.
  • Make sure that state-changing operations (gql mutations) are only triggered upon explicit user interactions such as form submissions.
  • Keep in mind that UI rendering in response to user navigating between views is only allowed to trigger read-only operations (gql queries and subscriptions) without any data mutations.

Protect against Cross-site scripting (XSS)

  • It is recommended to use JS frameworks that have built-in XSS prevention mechanisms, such as reactJS, vue.js or angular.
  • As a rule of thumb, you cannot perceive user input to be 100% safe. Get familiar with prevention mechanisms included in the framework of your choice. Make sure the user input is sanitized before it is embedded in the DOM tree.
  • Get familiar with the most common XSS bypasses and potential dangers. Keep them in mind when writing or reviewing the code.
  • Enable the Content-security-policy header for all new micro frontends to ensure in-depth XSS prevention. Do not allow for unsafe-eval policy.

Run tests

For more information about how to run tests and configure them, go to the tests directory.

Troubleshooting

TIP: To solve most of the problems with the Console development, clear the browser cache or perform a complete refresh of the web page.

CI fails on PRs related to staging dependencies

Remove the node_modules folder and the package-lock.json file in the compass directory and on the root. Then, rerun the npm run bootstrap command in the root context and push all changes.

Can't access compass.kyma.local:8080 after hibernating the Minikube cluster

To solve the problem, refer to the guidelines from this document.

Check the availability of a remote cluster

To quickly check the availability of remote clusters, use the checkClusterAvailability.sh script.

./scripts/checkClusterAvailability.sh {CLUSTER_URL}

# or

export CLUSTER_HOST=abc.com
./scripts/checkClusterAvailability.sh {cluster_subdomain}
# the same as ./scripts/checkClusterAvailability.sh {CLUSTER_SUBDOMAIN}.abc.com

# or

./scripts/checkClusterAvailability.sh
# Checks the availability of every cluster that has ever been set through setClusterConfig.sh
# or checked with checkClusterAvailability.sh on your machine.

# or

./scripts/checkClusterAvailability.sh -s {cluster_domain}
# Returns an appropriate exit code if the cluster is unavailable.