Skip to content

Latest commit

 

History

History
32 lines (26 loc) · 2 KB

README.md

File metadata and controls

32 lines (26 loc) · 2 KB

TL;DR

This folder holds kubernetes deployment and service resources for the gen3 web portal. The portal also imports configuration for the commons' manifest (see below). Configure and launch the portal with gen3 kube-setup-portal.

Portal customization

Several flags and files in a deployment manifest are available to customize the behavior and appearance of the gen3 web portal.

First, the portal_app property in the global object of manifest.json determines which "profile" the portal runs with. The portal's profile includes customizations necessary for the common's dictionary, so the bhc portal_app customizes the portal to work with the brain commons' dictionary.

Second, the optional tier_access_level property in the global object of manifest.json determines the access level of a common. Valid options for tier_access_level are libre, regular and private. Common will be treated as private by default. For regular level data commons, there's another configuration environment variable tier_access_limit, which is the minimum visible count for aggregation results. By default set to 1000.

The portal includes support for several customization profiles in its code base in various files under the data/config and custom/ folders. An environment may also define its own gitops profile by installing files under a manifest's portal/ folder (for example - reuben.planx-pla.net/portal) that override the default gitops profile defined in cloud-automation here:

$ ls -1F kube/services/portal/defaults/
gitops-createdby.png
gitops.css
gitops-favicon.ico
gitops.json
gitops-logo.png
```./kube/services/portal/README.md