Skip to content

Getting Started with Cluster Manager

This guide will walk you through the process of setting up and getting started with the Cluster Manager project. Cluster Manager allows administrators to manage host clusters and enables users to create and manage virtual clusters within those host clusters.

Before we begin, make sure you have cloned the necessary repositories:

Prerequisites

For Cluster UI (Frontend):

  • Node.js and npm: Ensure you have Node.js and npm installed. You can download them from nodejs.org.

For Cluster Service and Cluster API (Backend):

  • Python: Cluster Service and Cluster API are Python-based services. Install Python from python.org.

  • Dapr CLI: Install the Dapr CLI to manage Python services and facilitate RabbitMQ and HashiCorp Vault integration. You can get it from the Dapr Releases page.

Installation and Setup

Cluster UI (Frontend):

  1. Clone the Cluster UI repository:

git clone git@github.com:BerryBytes/cluster-ui.git

  1. Navigate to the project directory:

cd cluster-ui

  1. Install dependencies:

npm install

  1. Configure environment variables as needed (see Configuration Guide).

  2. Start the development server:

npm run dev

  1. Access the Cluster UI application in your web browser at http://localhost:3000.

Cluster Service and Cluster API (Backend):

  1. Clone the Cluster Service and Cluster API repositories:

git clone git@github.com:BerryBytes/cluster-service.git git clone git@github.com:BerryBytes/cluster-api.git

  1. Navigate to the respective project directories.

  2. Install Python dependencies for each service:

pip install -r requirements.txt

  1. Install the Dapr CLI if you haven't already (see prerequisites).

  2. Configure environment variables as needed (see Configuration Guide).

  3. Start each service using Dapr:

dapr run --app-id cluster-api --resources-path components/ -- python3 -m uvicorn main:app --reload --host 0.0.0.0 --port 8081

dapr run --app-id cluster-manager --resources-path components/ --app-port 8082 -- python3 main.py

With these steps completed, you'll have the Cluster Manager project up and running, ready for further configuration and usage.

For detailed configuration instructions, refer to Configuration Guide.

Next Steps

  • Register as a user using Keycloak (if not already registered).

  • Create virtual clusters, list existing clusters, and explore the project's features through the Cluster UI.

  • Refer to individual repository documentation for more advanced configuration and usage options.

  • If you encounter any issues, consult the troubleshooting section in the documentation.

Welcome to Cluster Manager! Enjoy managing your clusters effortlessly.

This "Getting Started.md" document provides step-by-step instructions for setting up and getting started with the Cluster Manager project, including prerequisites, installation steps, and next steps for users. You can customize and expand on this document as needed for your developer documentation.