Skip to content

Latest commit

 

History

History
195 lines (159 loc) · 12.8 KB

README.md

File metadata and controls

195 lines (159 loc) · 12.8 KB
Raw

Navig8

Simplify and Visualize Helm Deployments

The Navig8 web user interface simplifies Kubernetes application deployment by guiding users through Helm Chart values.

Its logic is executed only on frontend side which guarantees no sensitive data filled in its form will ever be implicitly processed somewhere outside user's computer.

Table of contents

Assumptions

  • Navig8's initial design is lightweight: all functionality is in the web client for easy web hosting.
    • There is no persistence for values or back-end requirements, see the Roadmap section for more on this topic.
  • The target Helm Chart repository is network accessible to the web client running Navig8.
  • The target Helm Chart has values.schema.json
  • OPTIONAL: the target Helm Chart has a README.md.
  • Navig8 leverages existing Helm Chart value specifications, see the Roadmap section for more on this topic.
  • Navig8 provides helm commands for execution.

Local development

Environment requirements

Starting from scratch

pnpm install
cp .env.template .env.development.local # Add values for required variables there. Each variable is documented inside the file.
pnpm dev

Building you own docker image from the repository root

docker build -f ./docker/Dockerfile .

Customization options

Environment variables:

Name Required Description Default
NAVIG8_REPO_URL * Url to the helm repository that is usually used in helm add repo command
NAVIG8_REPO_ENTRY * Entry is a unique key of the entries hash map (
https://helm.sh/docs/topics/chart_repository/#the-index-file
)
NAVIG8_REPO_NAME * The name of the repo used in the command helm repo add $NAVIG8_REPO_NAME $NAVIG8_REPO_URL
NAVIG8_PREDEFINED_NAMESPACE The k8s namespace that will be created and used for the helm installation
NAVIG8_DOCUMENTATION_URL Link to the documentation for the specified helm chart that will be provided to the user
NAVIG8_USE_PROXY Boolean-like string ("false" or "true"). Used in development and Docker env to tell whether a proxy should be created to bypass CORS headers or not "false"
NAVIG8_COPYRIGHT A string that will be shown on the right of the <footer> element. If you want to add a dynamic year that will represent year at the momet - add {year} to the string.

Example: ©{year} Kasten by Veeam®
NAVIG8_FAVICON Icon that can be usually seen inside the tab of the browser and is usually important for crawlers of social media, chat applications, and search engines.
NAVIG8_SEO_TITLE A small string that represents the content of the page that can be usually seen inside the tab of the browser and is usually important for crawlers of social media, chat applications, and search engines.
NAVIG8_METAS An array as JSON string with data for custom <meta> elements in html

The structure is (Typescript definition):
type Metas = Array<{name: string, content: string}>

Example:
[{"name": "description", "content": "This is my description"}]		 '[]'
NAVIG8_LINKS An array as JSON string with attributes for custom <link> elements in html

The structure is (Typescript definition):
type Links = Array<Record<string, string>>

Example: [{"rel": "canonical", "href": "http://example.com"}]		 '[]'
NAVIG8_TOP_HEAD
NAVIG8_BOTTOM_HEAD
NAVIG8_TOP_BODY
NAVIG8_BOTTOM_BODY		 Raw html that will be inserted in the index.html and will be statically served. Each variable name represents location where html will be inserted. ""
NAVIG8_BASE_URL URL relative to the domain root or an absolute one that represents path to the frontend folder with built static

Example: /pages/navig8		 '/'

Custom logo

By default, an icon from the manifest of the specified helm repo is used as a logo in the header of the interface.

It can be overwritten with the CSS rule background-image inside .logo class in the <REPO_ROOT>/light.css that is responsible for the light theme (We assume that we will support the dark theme as well in the nearest future) The logo can be of any format supported by the browser (but .svg is highly recommended)

This is how it could be done using only the terminal:

LOGO_URL=url
cat >> light.css <<- EOF
.logo {
   background-image: url($LOGO_URL);
}
EOF

You can also add a file there and set a relative path:

cp /some/where/else/logo.svg ./logo.svg
cat >> light.css <<- EOF
.logo {
   background-image: url(./logo.svg);
}
EOF

Themization

The interface is built using PrimeVue UI-kit which makes it possible to customize a theme.

It's possible to make the color scheme more brand-specific by setting it CSS variable in <REPO_ROOT>/light.css file that is dedicated to CSS overwrites for the light theme (We assume that we will support the dark theme as well in the nearest future).

There is a description of color palettes that this UI kit uses.

The method of adding a new scheme to the light.css file can be the same as for custom logo

cat >> light.css <<- EOF
:root {
  --primary-color:#3B82F6;
  --primary-color-text:#ffffff;
  /* other colors */
}
EOF

Overwriting CSS rules

Feel free to fork this repo and change styles or whatever you want, but if a fork is not the preferable option - an overwriting can be done in the same way as for custom logo and themization

Deployment as FE static

  1. Build frontend static using Available Customization options.
  2. Deployment to the server that serves static html/js/css
  3. CORS header Access-Control-Allow-Origin should be extended for the specified helm chart repo files with the domain where navig8 is run.

We have plans on simplifying this process. Please see the Roadmap section for more details

An example of deployment flow

It is assumed that we are inside the process where pnpm, git and node are available (Environment requirements).

  1. Clone the repo
git clone [email protected]:navig8s/navig8.git
  1. Install dependencies
pnpm install --frozen-lockfile
  1. Setup at least required ENV variables declared in this table. You can do it inside the terminal process of course.
NAVIG8_REPO_URL=repo_url
NAVIG8_REPO_ENTRY=entry
NAVIG8_REPO_NAME=name
  1. Build the frontend
pnpm build
  1. Copy the output of FE static inside <REPO_ROOT>/dist folder anywhere you want.
  2. Set Access-Control-Allow-Origin for the helm repo you've specified so navig8 could fetch all files it needs. For example, you host navig8 at https://navig8-instance.com. This should be included in the Access-Control-Allow-Origin header for all files in the specified helm chart.

Deployment as Docker container

Docker solution could be run in k8s cluster or by one of the popular cloud services like Google Cloud Run

  1. Get last image from ghcr registry
  2. Set at least required environment variables from the list
  3. Publish the Container's port 80, forward requests to domain of your choice to it as it will be listened for requests.
  4. Run Container

An example of running docker image locally

docker pull ghcr.io/navig8s/navig8
docker run -d -p 8080:80 \
  --env NAVIG8_REPO_URL=repo_url \
  --env NAVIG8_REPO_ENTRY=entry \
  --env NAVIG8_REPO_NAME=name \
  ghcr.io/navig8s/navig8

Proxy to bypass CORS & security notes

It's highly recommended to set CORS headers (Access-Control-Allow-Origin) for helm repo, that is going to be used by navig8 and thus handle CORS issue.

In case it's not an option - there is a possibility to use reverse proxy for Docker environment (see settings). Current realisation of the reverse proxy that is available in Docker environment is intended to be used for same-origin requests that nginx will proxy to the specified chart repo's url (frontend requests /repo that is proxied to NAVIG8_REPO_URL in current implementation).

Examples

  • [Coming soon]: install.kasten.io is a public Navig8 instance for the K10 Helm Chart.

Roadmap

  • Prebuilt Docker image with reverse proxy to bypass CORS inside
  • Possibility to skip values.schema.json file for the form construction
  • Possibility to view and edit values.yaml file
  • Dark theme support
  • Code of Conduct
  • Issues template