Paralus End-User Documentation

What is Paralus?

Paralus is a free, open source tool that enables controlled, audited access to Kubernetes infrastructure.

How to Access Paralus?

Prerequisites

  • You have a VSHN account that’s authorized to access Paralus.

Access

Follow these steps to access Paralus:

  1. Navigate to the Paralus web portal : console.paralus.vshn.ch

  2. Select "Sign in with VSHN Keycloak" and sign in with your VSHN credentials

  3. Use the dashboard to manage your Kubernetes clusters.

Features of Paralus

This section provides a concise overview of the main functionalities available in the Paralus web console. It includes instructions on managing and accessing Kubernetes clusters, configuring user permissions, and utilizing the command-line interface directly within the web UI.

Managing and Accessing Your Cluster

To manage and access your Kubernetes cluster using the Paralus web console:

  1. Log in to the Paralus console.

  2. Select "Go To Projects" to view the list of available projects.

    Once you are navigated inside a project, this area allows you to perform several actions:

    • Download kubeconfig files for cluster connections.

    • Execute kubectl commands directly within a cluster environment.

Downloading Kubeconfig Files

To download kubeconfig files for local use:

  1. Navigate to the "Projects" section of the console.

  2. Select the desired project and download the kubeconfig file.

    After downloading, you must export the kubeconfig file to your local environment to utilize it with your Kubernetes tools.

Using Kubectl in the Web UI

To execute kubectl commands within the web UI:

  1. Navigate to your project.

  2. Click on the "Kubectl" option for a cluster to open the command interface.

    Here, you can directly execute kubectl commands as if you were using your local command-line interface.

Configuring User Permissions

User permissions are exclusively managed by organizational administrators:

  • Please contact VSHN support for modifications or inquiries regarding user permissions.

Paralus for Rancher Users

To ensure a smooth transition, familiarize yourself with the operational specifics detailed in our guide here: Differences Between Rancher and Paralus.

Additional Resources

Maximize your use of Paralus by consulting these resources:

Reporting Issues

Encountering issues is a significant concern; please report them so they can be addressed: