/velum

Dashboard for CaaSP clusters

Primary LanguageRubyApache License 2.0Apache-2.0

Velum

master Code Climate
Build Status Code Climate Test Coverage

Velum is a dashboard that manages your SUSE CaaS Platform cluster. With Velum, you will be able to:

  • Bootstrap a Kubernetes cluster with a simple click.
  • Manage your Kubernetes cluster: adding and removing nodes from your cluster, monitoring faulty nodes, etc.
  • Setup an update policy that suits your needs. SUSE CaaS Platform already provides a transparent and sensible procedure for updates that guarantees no downtime, but with Velum you will be able to further tune this.

The architecture of CaaS Platform uses Salt quite heavily, and worker nodes are supposed to run as Salt minions. These Salt minions should then register to Velum, which acts as a Salt master. As an administrator, when setting up the cluster, you will see nodes popping up, and then you will be able to provision all the nodes from your cluster with Kubernetes in a single click.

Once you have bootstrapped your cluster, you will be presented with a web application that allows you to manage your cluster, define your update policy, and much more.

Configuration

From an existing Kubernetes application, set the following environment variables and start the server:

  • VELUM_SALT_HOST: IP of the Salt API server.
  • VELUM_SALT_PORT: Port of the Salt API server.
  • VELUM_SALT_USER: The user allowed to access the Salt API.
  • VELUM_KUBERNETES_HOST: IP of the Kubernetes API server.
  • VELUM_KUBERNETES_PORT: port of the Kubernetes API server.
  • VELUM_KUBERNETES_CERT_DIRECTORY: directory where the Kubernetes certificates are located.

Note that the development environment already sets all these values for you.

Development

You can start a Velum development environment by following the instructions in caasp-devenv.

Licensing

Velum is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.