SpotKube Web-UI

---

SpotKube Web-UI is a React-based user interface for managing and monitoring microservices on the SpotKube platform. It provides a graphical interface for interacting with SpotKube's features and functionalities.

Prerequisites

Before running the SpotKube Web-UI, ensure that you have the following prerequisites installed:

• Node.js (version 12 or above)
• npm (Node package manager)

Installation

Follow these steps to install and run the SpotKube Web-UI:

1. Clone the SpotKube Web-UI repository from GitHub:

   git clone https://github.com/SpotKube/Spotkube-UI.git

2. Navigate to the SpotKube-UI directory:

    cd SpotKube-UI

3. Environment Configuration

   To configure the environment for SpotKube, you need to set up the following variables in the .env file:

   REACT_APP_BASE_URL_REMOTE=http://34.198.51.121
   # REACT_APP_BASE_URL_REMOTE=http://127.0.0.1:8000
   
   REACT_APP_AWS_PROMETHEUS_URL=https://<aws-cloud-prometheus url>
   REACT_APP_PRIVATE_PROMETHEUS_URL=https://<private-cloud-prometheus url>
   
   

   Make sure to replace the values accordingly. Here's what each variable represents:

   • REACT_APP_BASE_URL_REMOTE: The base URL for the remote server. If you're running SpotKube locally, you can uncomment the second line and use the local address instead.

   • REACT_APP_AWS_PROMETHEUS_URL: The URL for AWS Prometheus. Replace this with the appropriate URL for your AWS Prometheus instance.

   • REACT_APP_PRIVATE_PROMETHEUS_URL: The URL for the private Prometheus. Replace this with the appropriate URL for your private Prometheus instance.

4. Install the dependencies:

   npm install

5. Run the application:

   npm start

6. Open the application in a browser at http://localhost:3000.

Usage

The SpotKube Web-UI provides a graphical interface for interacting with SpotKube's features and functionalities. For more detailed information and usage instructions, please refer to the SpotKube documentation.

Dashboard

The Dashboard is the landing page of the SpotKube Web-UI. It provides an overview of the currently running AWS spot instances and private cloud instances. It also offers complete end-to-end APIs for deploying microservices and destroying cloud resources.

Task Based APIs

The Task Based APIs page provides a list of APIs that can be used to perform various operations, including node allocation, node configuration, microservice deployment, and cloud resource destruction.

Logs

The Logs page displays a list of logs generated by the SpotKube services. It includes the following log categories:

• Provisioning Logs: Logs generated during the node allocation process.
• Configuring Logs: Logs generated during the node configuration process.
• Deployment Logs: Logs generated during the microservice deployment process.

Spot Pricing

The Spot Pricing page provides a list of spot prices for different instance types that are currently running in AWS.

License

SpotKube is released under the Apache 2.0 license. For more information, please refer to the license file.

Support

For support or assistance, please open an issue on the SpotKube Web-UI repository.