# Welcome to K8Studio Documentation

Explore the comprehensive documentation for K8Studio, your key resource for mastering Kubernetes. Discover a simplified yet powerful approach that enhances your understanding and proficiency in Kubernetes management. Dive into the details and make the most of K8Studio's features to elevate your experience with container orchestration.

<figure><img src="/files/sjymIVivmnWdJ3RlT7j7" alt=""><figcaption><p>K8Studio Presentation View</p></figcaption></figure>

## Quick links

{% content-ref url="/pages/PWD6Kr3iTYqRjhlJ3npB" %}
[What is K8Studio](/overview/what-is-k8studio)
{% endcontent-ref %}

{% content-ref url="/pages/OFurqlrzWWe00OdHegw0" %}
[Our Features](/overview/our-features)
{% endcontent-ref %}

## Get Started

We've put together some helpful guides for you to get set up with our product quickly and easily.

{% content-ref url="/spaces/MXXfpTvt6Xe4Y0tCwViA/pages/93gHQrlR9lP3kq2Y8tVd" %}
[Getting Started](/documentation/getting-started)
{% endcontent-ref %}

{% content-ref url="/spaces/MXXfpTvt6Xe4Y0tCwViA/pages/dgeDjMEFFJk5bSxjn6Cl" %}
[Activation & Licenses](/documentation/activation-and-licenses)
{% endcontent-ref %}


# What is K8Studio

Video Overview

Got 2 minutes? Check out a video overview of K8Studio:<br>

<br>

{% embed url="<https://youtu.be/_jad84k6zfU>" %}
K8Studio Presentation
{% endembed %}


# Our Features

**Cluster  Manager**

The Cluster Management window is where your Kubernetes management journey kicks off. Here, you can add, delete, and organize your clusters effortlessly. K8studio smartly reads clusters from your .kube/config without altering it. Yet, we understand your Kubernetes landscape might extend beyond. That’s why we empower you to manually add clusters or import them from various configuration files, all without disturbing the original setup.

<figure><img src="/files/3LSbDo6U33mnC9i2C3A5" alt=""><figcaption></figcaption></figure>

**Graphical view**

After opening a cluster, the first window reveals the Deployment View, a user-friendly graphical snapshot offering a holistic overview of the cluster. This view groups workloads, services, ingresses, and persistent volumes by namespace and instance. Furthermore, it visually represents the connections between different objects, providing a swift assessment of pod count and status.

<figure><img src="/files/dPsJvkWvRQ2C2Usu3dkL" alt=""><figcaption></figcaption></figure>

What makes this view exceptional is its complete interactivity. Users can perform CRUD operations using intuitive D\&D functionality. The sidebar complements this by allowing users to edit object definitions swiftly. Featuring a quick editor, YAML editor, log pages, and, if Prometheus is deployed, showcasing metrics of the selected object directly from the graphical view.

<figure><img src="/files/UkQgTpIFgorBR9ABNSww" alt=""><figcaption></figcaption></figure>

**Grid view**

Switching to the grid view allows for a comprehensive tabular display of all Kubernetes objects. The left bar enables the selection of specific object types, and this view is entirely interactive and updated in real-time. Users can seamlessly search and filter objects by namespace, rearrange columns, and create custom filters. This ensures an efficient and customized way to locate the desired information with ease.

<figure><img src="/files/OxygEd42XDkOQYJt8qPL" alt=""><figcaption></figcaption></figure>

**Node View**

The Node View offers a comprehensive display of all available nodes, showcasing the pods they house along with their current status. Additionally, it provides key insights into the CPU and memory status, offering a holistic perspective on the overall health and performance of the nodes within the cluster.

<figure><img src="/files/85Y6X4b9pV9ArC99jTH1" alt=""><figcaption></figcaption></figure>

**Integrate Terminal**

No Kubernetes tool is complete without a terminal! Enter our world-class integrated terminal — a constant companion that supports multiple instances and remembers the correct cluster context. This feature ensures a seamless experience, allowing users to download to text and switch between multiple shell types effortlessly. The terminal is always at your fingertips, ready to enhance your Kubernetes management experience.

<figure><img src="/files/nLH9yR6F9TrOhwEs0BZz" alt=""><figcaption></figcaption></figure>

**Helm View**

The Helm view serves as a centralized hub for managing Helm repositories. Users can effortlessly search, install charts, and oversee the entire lifecycle of installed releases. This feature streamlines the Helm-related operations, providing a seamless and efficient experience for repository management and chart deployment within the cluster.

<figure><img src="/files/XXEy3AWjqhBiYcoNz1lo" alt=""><figcaption></figcaption></figure>

**RBAC View**\
The RBAC (Role-Based Access Control) view simplifies the creation and management of cluster roles and roles. Users can easily configure permissions and assign them to individuals, groups, or service accounts. Additionally, this view facilitates the creation of users and groups, providing a summary of user permissions.

<figure><img src="/files/bx19RVoCSYU1PNtVARvN" alt=""><figcaption></figcaption></figure>


# Getting Started

In the following sections, we will explain how to install K8Studio in different environments, as well as show how to get the corresponding activation Code and how to manage your liceneses.

{% content-ref url="/pages/M3siLmVB8GP2JGNgYBH2" %}
[Mac Installation](/documentation/getting-started/mac-installation)
{% endcontent-ref %}

{% content-ref url="/pages/cJtFQrC3qoWAfHxG9eU2" %}
[Windows Installation](/documentation/getting-started/windows-installation)
{% endcontent-ref %}

{% content-ref url="/pages/2XAfff22ISOPdawPocT4" %}
[Linux Installation](/documentation/getting-started/linux-installation)
{% endcontent-ref %}

{% content-ref url="/pages/3WIR8M70I9ePNRn0Uuvu" %}
[WSL Installation](/documentation/getting-started/wsl-installation)
{% endcontent-ref %}


# System Requirement

Before installing and running K8Studio, please ensure that your system meets the following minimum requirements:

#### Operating System:

* **macOS:** Version 10.12 (Sierra) or later.
* **Windows:** Windows 7 or later.
* **Linux:** Ubuntu 16.04 LTS or later, Fedora 25, or equivalent.

#### Processor:

* A modern, multi-core processor is recommended for optimal performance.

#### Memory (RAM):

* Minimum: 2 GB RAM
* Recommended: 4 GB RAM or higher for improved responsiveness.

#### Storage:

* A minimum of 200 MB of free disk space is required for the application installation.
* Additional space may be required for user data and updates.

#### Graphics:

* A graphics card that supports hardware acceleration for smoother rendering.
* A display with a minimum resolution of 1024x768 pixels.

#### Internet Connection:

* An active internet connection is required for initial installation and updates.


# Mac Installation

* **Download the DMG file:**
  * Visit the official website <https://k8studio.io>.
  * Look for a download section or button and choose the DMG file appropriate for your Mac architecture (Intel or Arm64).
* **Open the DMG file:**
  * Locate the downloaded DMG file in your Downloads folder or the location you specified.
  * Double-click on the DMG file to open it. A new window will appear.
* \
  ![](/files/lmxxLtugfMHVIXgEu664)
* **Install the application:**
  * In the DMG window, you will usually see the application icon and sometimes a shortcut to the Applications folder.
  * Drag the application icon to the Applications folder (or follow any specific installation instructions provided).
* **Eject the DMG:**
  * After the application is copied to the Applications folder, close the DMG window.
  * Eject the DMG by right-clicking on its icon on the desktop and selecting "Eject" or by clicking the eject button next to the DMG in Finder.
* **Launch the application:**
  * Go to the Applications folder on your Mac.
  * Locate the installed application and double-click on it to launch.
* **Optional: Delete the DMG file:**
  * Once you have successfully installed the application, you can delete the DMG file unless you want to keep it for backup purposes.


# Windows Installation

#### Download the Installer:

1. Visit the official website  <https://k8studio.io>.
2. Look for a download section or button and choose the installer appropriate for your Windows version.

#### Run the Installer:

1. Once the installer is downloaded, locate the file, usually in your Downloads folder.
2. Double-click on the installer file (usually ending with `.exe`) to start the installation process.

<figure><img src="/files/PiJWwc1ljC9i6mlUd0Wg" alt="" width="375"><figcaption></figcaption></figure>

#### Installation Wizard:

1. The installation wizard will guide you through the setup process. Click "Next" to proceed.
2. Read and accept the license agreement if prompted.
3. Choose the destination folder for the installation or use the default folder.
4. Select any additional options or components if provided.
5. Click "Install" to begin the installation process.

#### Complete the Installation:

1. Once the installation is complete, you may see a confirmation or completion message.
2. Optionally, select the option to launch k8Studio immediately after installation.
3. Click "Finish" to exit the installer.


# Linux Installation

## **Debian 12+:**

1. **Download the Package:** Download the latest `k8studio.deb +12` package from the appropriate source. You might obtain this from the official website or another trusted repository.
2. **Open Terminal:** Open a terminal window on your Debian or Ubuntu system. You can do this by searching for "Terminal" in the applications menu or by using the shortcut `Ctrl + Alt + T`.
3. **Navigate to the Directory:** Use the `cd` command to navigate to the directory where the `k8studio.deb` package is located. For example, if it's in the Downloads folder, you can navigate there using

```
cd ~/Downloads
```

1. **Install the Package:** Install the `k8studio.deb` package using the `dpkg` command. Replace `k8studio.deb` with the actual filename if it's different.

```
sudo dpkg -i k8studio.deb
```

## **Debian 10:**

1. **Download the Package:** Download the latest `k8studio.deb 10` package from the appropriate source. You might obtain this from the official website or another trusted repository.
2. **Open Terminal:** Open a terminal window on your Debian or Ubuntu system. You can do this by searching for "Terminal" in the applications menu or by using the shortcut `Ctrl + Alt + T`.
3. **Navigate to the Directory:** Use the `cd` command to navigate to the directory where the `k8studio.deb` package is located. For example, if it's in the Downloads folder, you can navigate there using

```
cd ~/Downloads
```

1. **Install the Package:** Install the `k8studio.deb` package using the `dpkg` command. Replace `k8studio.deb` with the actual filename if it's different.

```
sudo dpkg -i k8studio.deb
```

## **App Image:**

1. **Download the K8studio AppImage:** Download the "K8studio.appImage" file from the official website or another trusted source.
2. **Set Execution Permissions:** Open a terminal window and navigate to the directory where the "K8studio.appImage" file is located. Use the `chmod` command to make the AppImage file executable. For example:

   ```bash
   chmod +x K8studio.appImage
   ```
3. **Optional: Move to a Preferred Location:** You can optionally move the AppImage file to a preferred location on your system. For example, you might move it to the `~/Applications` directory. Use the `mv` command for this purpose. For example:

   ```bash
   mv K8studio.appImage ~/Applications
   ```
4. **Launch the AppImage:** To run the K8studio AppImage, simply double-click on it in your file manager or execute it from the terminal. If you moved the AppImage to a different directory, navigate to that directory in the terminal first. For example:

   ```bash
   cd ~/Applications
   ./K8studio.appImage
   ```
5. **Optional: Create Desktop Shortcut:** If you want to create a desktop shortcut for the K8studio AppImage, you can do so manually or by using tools provided by your desktop environment.

## **Fedora:**

1. **Download the RPM Package:** Download the `k8studio.rpm` package from the official website or another trusted source.
2. **Open Terminal:** Open a terminal window on your Fedora system. You can do this by searching for "Terminal" in the applications menu or by using the shortcut `Ctrl + Alt + T`.
3. **Navigate to the Directory:** Use the `cd` command to navigate to the directory where the `k8studio.rpm` package is located. For example, if it's in the Downloads folder, you can navigate there using:

   ```bash
   cd ~/Downloads
   ```
4. **Install the Package:** Install the `k8studio.rpm` package using the `dnf` package manager. Use the following command:

   ```
   sudo dnf install k8studio.rpm
   ```
5. **Enter Your Password:** When prompted, enter your user password. Note that you need to have sudo privileges to install packages on Fedora.
6. **Wait for Installation:** Allow the installation process to complete. The `dnf` package manager will handle dependencies and install the package accordingly.
7. **Verify Installation:** After the installation is complete, you can verify that K8Studio is installed correctly by running:

   ```css
    codek8studio --version
   ```

   This should display the installed version of K8Studio.
8. **Launch K8Studio:** You can now launch K8Studio from the application menu or by running:

   ```
   k8studio
   ```

That's it! You have successfully installed K8Studio on your Fedora system using the RPM package

## **FreeBsd:**

1. **Download the FreeBSD Package:** Download the FreeBSD package for K8Studio, typically named `k8studio.freebsd`, from the official website or another trusted source.
2. **Open Terminal:** Open a terminal window on your FreeBSD system. You can do this by navigating to the Applications menu or by using a shortcut.
3. **Navigate to the Directory:** Use the `cd` command to navigate to the directory where you downloaded the K8Studio package. For example:

   ```bash
   cd ~/Downloads
   ```
4. **Install the Package:** Install the K8Studio package using the `pkg` package manager. Use the following command:

   ```
   sudo pkg install k8studio.freebsd
   ```
5. **Enter Your Password:** When prompted, enter your user password. Note that you need to have sudo privileges to install packages on FreeBSD.
6. **Wait for Installation:** Allow the installation process to complete. The `pkg` package manager will handle dependencies and install the package accordingly.
7. **Verify Installation:** After the installation is complete, you can verify that K8Studio is installed correctly by running:

   ```css
   k8studio --version
   ```

   This should display the installed version of K8Studio.
8. **Launch K8Studio:** You can now launch K8Studio from the application menu or by running:

   ```
   k8studio
   ```

That's it! You have successfully installed K8Studio on your FreeBSD system using the `k8studio.freebsd` package.


# WSL Installation

To set up K8Studio on Windows Subsystem for Linux (WSL)

1. Open WSL Terminal
2. Install required software

```
sudo apt-get install -y libgbm-dev
sudo apt-get install libasound2
```

3. Download the latest Debian binary of K8Studio

```
wget  -P ./ https://github.com/guiqui/k8Studio/releases/download/v0.2.2-alpha/K8Studio_0.2.2-alpha_amd64.deb)
```

4. Install the package

```
sudo dpkg -i ./K8Studio_0.2.2-alpha_amd64.deb
```

5. Install <https://command-not-found.com/gtk-launch>
6. Launch application

```
gtk-launch k8studio.desktop
```


# Activation & Licenses

Once you have installed the application, the next step is to obtain an activation code to activate K8Studio. Alternatively, you can choose Guest Mode if you wish to try it without needing to go through the activation process:

{% content-ref url="/spaces/MXXfpTvt6Xe4Y0tCwViA/pages/6XY9NAuRSA9Nbglac4Lk" %}
[Creating Account](/documentation/activation-and-licenses/creating-account)
{% endcontent-ref %}

{% content-ref url="/spaces/MXXfpTvt6Xe4Y0tCwViA/pages/anujVMuvgk58YvYJadUh" %}
[Personal](/documentation/activation-and-licenses/personal)
{% endcontent-ref %}

{% content-ref url="/pages/1j3yhiZlT87UlwuhCEcw" %}
[Professional](/documentation/activation-and-licenses/professional)
{% endcontent-ref %}

{% content-ref url="/spaces/MXXfpTvt6Xe4Y0tCwViA/pages/fEzo3diVzScsVd8wTAIv" %}
[Professional Airtight](/documentation/activation-and-licenses/professional-airtight)
{% endcontent-ref %}

The following section will demonstrate how you can manage your licenses, including assigning them, inviting people to redeem them, and other related tasks.<br>

{% content-ref url="/spaces/MXXfpTvt6Xe4Y0tCwViA/pages/lyPqCbzJqc95oX0h5456" %}
[License Management](/documentation/activation-and-licenses/license-management)
{% endcontent-ref %}


# Creating Account

To create an account in  K8Studio, you need to go to <https://accounts.k8studio.io/>

#### 1. Sign Up Process

1.1. **Click on "Sign Up":**

* Navigate to the K8Studio website or app.
* Locate and click on the "Sign Up" button.<br>

1.2. **Enter User Details:**

* Provide a valid email address to be used as your username.
* Choose a secure password that meets the specified requirements.
* Fill in any additional required information.

<figure><img src="/files/UkKWKQl2uDPD5BhQvkNp" alt=""><figcaption></figcaption></figure>

1.3. **Click on "Sign Up":**

* After entering your details, click on the "Sign Up" button to proceed.<br>

  <figure><img src="/files/kIb1I8sjKiFCBX4YJmR1" alt=""><figcaption></figcaption></figure>

#### 2. Email Verification

2.1. **Check Your Email:**

* Open the email account associated with the provided email address

2.2. **Find Verification Email:**

* Look for an email from K8Studio with the subject "Account Verification."

2.3. **Open Verification Email:**

* Open the email and locate the verification code provided.<br>

  <figure><img src="/files/fxW49ekyBwQembFla4Gq" alt=""><figcaption></figcaption></figure>

#### 3. Activate Your Account

3.1. **Paste Verification Code:**

* Return to K8studio app.
* Navigate to the activation page and enter the verification code from the email.

3.2. **Complete Activation:**

* Click on the "Activate"  button to complete the activation process.<br>

  <figure><img src="/files/QUXAt5FDFRVNDt1hSeNO" alt=""><figcaption></figcaption></figure>

#### 4. Sign In to Your Account

4.1. **Click on "Sign In":**

* Return to the main page and click on the "Sign In" button.<br>

  <figure><img src="/files/pDxhxChBkJKOoOR6PaPh" alt=""><figcaption></figcaption></figure>

4.2. **Enter User Credentials:**

* Input your registered email address and password.

4.3. **Access K8Studio:**

**Note:** Keep your login credentials secure, and if you encounter any issues during the registration process, feel free to contact our support team at \[<info@k8studio.io>].


# Personal

Upon launching K8Studio for the first time, you will encounter a dialog that provides three activation options.&#x20;

* **Select "Activation Online":**
  * In the activation options dialog, click on "Activation Online"
  * A Webrowser Page will open directing you to the <https://accounts.k8studio.io/> website<br>

    <figure><img src="/files/4PnDDxyPsH5ZxMCBHL6I" alt="" width="375"><figcaption></figcaption></figure>

<br>

* **Create an Account or Sign in:**\
  Please read the Creation Account section

{% content-ref url="/spaces/MXXfpTvt6Xe4Y0tCwViA/pages/6XY9NAuRSA9Nbglac4Lk" %}
[Creating Account](/documentation/activation-and-licenses/creating-account)
{% endcontent-ref %}

* **Activate Personal Version :** \
  Choose the option to "Activate Personal" and click on the "Activate" button.<br>

<figure><img src="/files/hUZL4FWbr0OVsNVjwHL4" alt="" width="375"><figcaption></figcaption></figure>

A popup window will appear, prompting you to open K8Studio. Click on "Open K8Studio.

<figure><img src="/files/vWmVXCy5jVBfXSuOqRVb" alt="" width="298"><figcaption></figcaption></figure>

* **K8Studio will display an activation confirmation message.**\
  ![](/files/RVRhKCPftXG13bFoqNB8)\
  You should also see the license type and status in the bottom bar on the right![](/files/UvVFem8LFxWjibKOxnq7)<br>


# Professional

Upon launching K8Studio for the first time, you will encounter a dialog that provides three activation options.&#x20;

* **Select "Activation Online":**
  * In the activation options dialog, click on "Activation Online"
  * A Webrowser Page will open directing you to the <https://accounts.k8studio.io/> website<br>

    <figure><img src="/files/4PnDDxyPsH5ZxMCBHL6I" alt="" width="375"><figcaption></figcaption></figure>

<br>

* **Create an Account or Sign in:**\
  Please read the Creation Account section

{% content-ref url="/spaces/MXXfpTvt6Xe4Y0tCwViA/pages/6XY9NAuRSA9Nbglac4Lk" %}
[Creating Account](/documentation/activation-and-licenses/creating-account)
{% endcontent-ref %}

* **Activate Professional Version :** \
  Choose the option to "Buy Professional"  this will navigate to the Purchase page.

<figure><img src="/files/hUZL4FWbr0OVsNVjwHL4" alt="" width="375"><figcaption></figcaption></figure>

* **Purchase Page:**\
  In the purchase, you can select your subscription type and the number of devices you require. If you prefer the standard Professional version, ensure to keep the Airtight option off. Once you have made your selection, it will take you to the checkout page.\ <br>

<figure><img src="/files/MCHg91mY8En9l6lTSJsb" alt="" width="375"><figcaption></figcaption></figure>

* **Checkout Page:**\
  In the checkout page, please enter your payment information along with your address. This information will appear on your invoice. If you are purchasing as a company, click on the bottom option 'I'm purchasing as a business' and enter your tax ID.

<figure><img src="/files/lMUNKcbh4ER2RWIsfQlY" alt=""><figcaption></figcaption></figure>

* **Success  Page:**\
  Once the purchase has been processed, the checkout page will redirect to the success page, and a popup window will appear, prompting you to open K8Studio. Click on "Open K8Studio".<br>

<figure><img src="/files/vWmVXCy5jVBfXSuOqRVb" alt="" width="298"><figcaption></figcaption></figure>

* [**K8Studio will display an activation confirmation message.**](#user-content-fn-1)[^1]

\
![](/files/RVRhKCPftXG13bFoqNB8)

\
You should also see the license type and status in the bottom bar on the right

![](/files/UvVFem8LFxWjibKOxnq7)<br>

[^1]:


# Professional Airtight

If you find yourself needing to activate a license on a machine isolated from any external network, such as an airtight or air-gapped system, you will have to purchase an Airtight License and proceed with the following steps

1. On the activation page, navigate to the 'Activate Airtight' section and click on the 'Copy' button to obtain the airtight identifier.

<br>

<figure><img src="/files/xnVWcjnklRLrIQhE2xWs" alt=""><figcaption><p>Copy Airtight identifier</p></figcaption></figure>

2. If you have internet access on a machine, navigate to <https://accounts.k8studio.io/> and log in. If you don't have an account, follow these instructions to create one.

{% content-ref url="/pages/6XY9NAuRSA9Nbglac4Lk" %}
[Creating Account](/documentation/activation-and-licenses/creating-account)
{% endcontent-ref %}

3. Purchase an Airtight License by selecting 'Yes' when prompted about the Airtight License option. It's important to note that once a license is activated, it cannot be unassigned.

<figure><img src="/files/4kTwrRadYSEkf1GwMyBP" alt="" width="479"><figcaption></figcaption></figure>

4. Once you've purchased the license, you'll be redirected to the Airtight Code activation page. Copy your Airtight identifier and click on "Generate"

<figure><img src="/files/GTFikcUp2hPQ0dH73Iw7" alt=""><figcaption></figcaption></figure>

5\. After clicking on "Generate," the application will display the Airtight activation code, allowing you to either copy it or download it for your records.

<figure><img src="/files/8sZziBo2nWqqL6EpMDEF" alt=""><figcaption></figcaption></figure>

6. Now, return to the application and paste the activation code into the designated text area. Then, click on "Activate" to complete the process.

<figure><img src="/files/PrJ65xLsYXiqSERraUML" alt=""><figcaption></figcaption></figure>


# License Management

Coming soon!


# Cluster Manager

<figure><img src="/files/LBqn5K9YIP4B2iVTONeV" alt=""><figcaption></figcaption></figure>

The cluster manager is the place in K8studio where you can manage your clusters. You can add clusters or monitor a file or a folder with cluster configurations. This is also the place where you can have an overview of all the clusters that you manage using the cluster summary metrics. This view also gives you the possibility of personalizing the appearance and feel of each cluster by changing the display name, color, or icon. This way, you can make the clusters more recognizable and accessible. Last but not least, this view allows you to create groups and hierarchies with color coding to organize your clusters.

{% content-ref url="/spaces/MXXfpTvt6Xe4Y0tCwViA/pages/6TO8NG2im2G8Np8D4uxv" %}
[Adding Clusters](/documentation/cluster-manager/adding-clusters)
{% endcontent-ref %}

{% content-ref url="/spaces/MXXfpTvt6Xe4Y0tCwViA/pages/hoUQjKk3OgX8WJ2r2iu0" %}
[Cluster Setting](/documentation/cluster-manager/cluster-setting)
{% endcontent-ref %}

{% content-ref url="/spaces/MXXfpTvt6Xe4Y0tCwViA/pages/CXhLU7cPME4Gt89cDguB" %}
[Groups and Interface options](/documentation/cluster-manager/groups-and-interface-options)
{% endcontent-ref %}


# Adding Clusters

In K8Studio, there are three ways of adding a cluster configuration.

1. **Add cluster by providing YAML:** If you have your YAML configuration, simply click on the plus button on the cluster manager toolbar. Once clicked, a context menu will appear. Choose the option "Add KubeConfig".

<figure><img src="/files/gbvDhMnu9ZtF6oLJnAIq" alt=""><figcaption></figcaption></figure>

A window will appear with a YAML editor. Copy and paste your cluster configuration into the editor, then click save.

<figure><img src="/files/k18NKFjXmxvWxYyOE3Bf" alt=""><figcaption></figcaption></figure>

K8 Studio will parse the provided configuration and add the clusters to the list.

2. **Add cluster by providing a configuration File(s)**\
   To add a cluster by providing a configuration file(s) in K8Studio, follow these steps<br>

   1. Click on the plus button on the main cluster manager toolbar. This will bring up a context menu.
   2. Select 'Sync File(s)'. A file explorer window will appear.
   3. Choose the file(s) that you want to import.
   4. If the configuration does not contain any errors, K8Studio will add them to the cluster list.

   \
   One significant advantage of this method is that once you add a file, K8Studio will monitor these files for changes. So, if you modify the content, K8Studio will detect the changes and synchronize with the new configuration automatically.

<figure><img src="/files/eZkTYcusiBN2LJa6eWk9" alt=""><figcaption></figcaption></figure>

3. **Add cluster by providing a configuration Folder:**\
   To add a cluster by providing a configuration folder in K8Studio, follow these steps:<br>

   1. Click on the plus button on the main cluster manager toolbar. This will bring up a context menu.
   2. Select 'Sync Folder'. A file explorer window will appear.
   3. Choose the folder that you want to import.
   4. K8Studio will read all the configuration files present within the selected folder and add these configurations to the list of available clusters in K8Studio.

   \
   One significant advantage of this method is that once you add a folder, K8Studio will monitor all the files under this folder for changes. So, if you modify the content of any of the files, K8Studio will detect the changes and synchronize with the new configuration automatically.


# Cluster Setting

1. First, select a cluster from the list.
2. Once the cluster is selected, you have two options:
   * Click on the settings button located on the main toolbar.<br>
   * Open the cluster context menu on the grid by clicking on the three-dot button, then select "Cluster Settings".

<figure><img src="/files/NpTPq6HUB3ecuraf96r1" alt="" width="352"><figcaption></figcaption></figure>

Once selected, the cluster settings page will open. Here are the different submenus that this page offers:

1. **Configuration:** In this section of the settings page, we can:
   * Change the display name of the cluster.
   * Access the location of the configuration file. Clicking on it will open your favorite editor, allowing you to make changes.
   * Color picker: Allows you to color-code your cluster.
   * Icon Picker: Allows you to select an icon to represent your cluster.
2. **NodeShelll**
   * Node Shell Image: Allows you to customize the image used to create a node shell pod.
   * Image Pull Secret: Allows you to set the secret name that permits pulling the node shell image from your private repository.
3. **Metrics:** K8Studio uses Prometheus as a metric provider. Here, you can specify the namespace, service name, and port of your Prometheus service.
4. **Namespaces:** In cases where you are accessing the cluster with restricted access, you need to inform K8Studio which namespaces you are allowed to query within the cluster.
5. **Proxy:** If you want to set a proxy to connect to your cluster, this is where you can configure it. You will need to provide the protocol, host, and settings. K8 Studio supports (HTTP, HTTPS, SOCKS4, SOCKS5). If this setting is not configured, K8Studio will use the proxy URL setting, if any, that is specified in the cluster config. If none of the previous settings are configured, K8Studio will use the environment variables HTTP\_PROXY and HTTPS\_PROXY to determine the cluster's proxy settings.


# Application Cluster settings

In K8Studio, there are certain settings available to define how the application is going to interact with the cluster. These settings are accessible either from the grid itself or from the cluster context menu, which can be accessed by clicking on the three-dotted button near the cluster icon.

<figure><img src="/files/VhbHMbrtOmXkwbUsEARx" alt=""><figcaption></figcaption></figure>

1. **Visibility:** This setting allows you to toggle the visibility of the cluster. If the visibility of a cluster is turned off, it will not be displayed in K8Studio. The cluster will only be visible on the grid if we toggle the visibility option on the grid to see all clusters.

<figure><img src="/files/hpbq4A2Ey6ptNUMzxVo5" alt=""><figcaption></figcaption></figure>

2. **HotBar:** This setting allows you to determine whether a cluster is included in the detail cluster hotbar. The hotbar is an icon list on the detail view that allows us to navigate to a cluster without leaving the detail view.
3. **Monitor:**&#x54;his setting allows you to enable or disable monitoring on a cluster. By default, the cluster manager attempts to retrieve summary information for any visible cluster. If you prefer K8Studio not to gather monitoring information for the selected cluster, you can turn monitoring off.


# Groups and Interface options

The Cluster Manager gives you the option to create groups and subgroups to organize your cluster into logical units. It's the same concept as any file system.

This section describes the main functionality of groups.

1. **Adding a Group:** To create a group, select the group under which you want to create the new group (if there is no group, you can choose "All," which is the root group), then right-click. The group context menu will appear; click on "New Group," and the 'Add Group' window will appear. Now, you can choose the name of the group and color code it with the color picker. Click on "Save" to create your group.

<figure><img src="/files/f2ywVorMYqVCvliqL0iT" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/NYAbYxKs0WjHCRcIaIWD" alt=""><figcaption></figcaption></figure>

1. **Editing a Group:** Select the group you want to edit, right-click, and select "Edit" from the context menu. The 'Edit Group' window will appear. Now, you can change the name and color of your group.
2. **Deleting a Group:** Select a group, right-click, and choose "Delete" from the context menu.
3. **Adding a Cluster to a Group from the Grid View:** From the grid, we can add a cluster to a group simply by grabbing the cluster from the row handler icon and dragging & dropping it onto the selected group.

<figure><img src="/files/sN7ruXymVxFdxpV1GLC9" alt=""><figcaption></figcaption></figure>

1. **Adding a Cluster from the Card View:** From the card view, we can either drag & drop the card onto the selected group in the tree or onto the card view groups themselves.

<figure><img src="/files/ZDuIgd3F4gGtxebCAE3Y" alt=""><figcaption></figcaption></figure>


# Monitoring

The Cluster Manager offers users an overview of the status of nodes and pods across all visible clusters. These metrics are shown when K8Studio can connect to the cluster and the monitoring configuration is enabled.

We have 2 types of metric graphs:

1. **Cluster Node Metrics:** This graph shows, node by node, the usage status of CPU and Memory. The graph can be hovered over to obtain a tooltip with detailed information

<figure><img src="/files/dFYAQXHLCzlS0uiAe9PG" alt=""><figcaption></figcaption></figure>

2. **Cluster Pods status:** This graph shows the status and count of pods running on the cluster.

<figure><img src="/files/0DuBahXfmG1a1WqdBNhw" alt=""><figcaption></figcaption></figure>


# Grid and Card View

The Cluster view offers to view,  Grid view, and Card View:

The Grid view is better suited for users who have many clusters, while the card view offers a more detailed view of each cluster. You can toggle between these modes by clicking on the buttons located at the top right, near the visibility button.

1. Grid View:\
   These are the main functionalities  of the Grid View:
   1. MultiColumn sorting
   2. Filtering&#x20;
   3. Reoder and moving columns

<figure><img src="/files/gSHeMDQnNErX5rI6bs7j" alt=""><figcaption></figcaption></figure>

1. Card View \
   These are the main functionalities  of the Card View:
   1. Allow to create groups.
   2. Add clusters on group.
   3. Drag and Drop Cluster in to card view Group.

<figure><img src="/files/AwiT4fCfaGp5SfbmqDd9" alt=""><figcaption></figcaption></figure>


# Deployment View

In this section, we will describe the Deployment View that is by default the first view that we see once we open a Cluster


# Overview

<figure><img src="/files/S9IyZpDuii6U5ECZqnpe" alt=""><figcaption></figcaption></figure>

The Deployment View is a graphical representation of a cluster. It shows the different namespaces, subgroups within each namespace, ingress, services, workloads with their pods and statuses, as well as the Persistent Volume Claims. It also displays the links and relationships between each of these objects.

The Deployment View serves three main purposes:

1. To allow users to gain a deep understanding of what is running on the cluster in a matter of seconds.
2. Real-time monitoring of the objects. The Deployment View provides a real-time representation of the cluster and updates as the cluster data updates. This makes this view perfectly suited for reporting on objects' CRUD operations and, mostly, on the status of the different pods.
3. Low-code functionality. For beginners in Kubernetes, this view allows you to create objects and relationships visually with minimal code. So, if you are experimenting with Kubernetes or have a small organization with no professional DevOps, this view can help you take your first steps with a Kubernetes cluster.

In this section, we will describe the different graph objects and what they represent:

1. **Namespaces and Namespace Subgroups:** Namespaces are represented with rectangles that contain every other object available under the namespace. Namespaces also contain subgroups that are calculated using the `app.kubernetes.io/name` label of all the different objects that are part of the namespace. What K8studio does is calculate all the different subgroups and order the objects by subgroup. If this label is not set, the object will be part of the default subgroup. Namespaces are selectable, and they can be edited once selected using the sidebar.

<figure><img src="/files/X1uQqjlOWVGs5vgrnkmy" alt=""><figcaption></figcaption></figure>

2. **Workloads**: Any workload is color-coded in blue. The title section indicates the type of workload, the name of the workload, and the number of replicas when relevant. In the middle, there are icons that represent the containers that the pods of the workload are running. If the container is running a well-known image, K8Studio will use a custom icon; if not, a generic Kubernetes one is used. The bottom section shows the pods that are running, and they are color-coded by status.

<figure><img src="/files/5fGmd0geQTWnQuBypZac" alt=""><figcaption></figcaption></figure>

2. **Service**: Services and any network object are color-coded in green. The title and subtitle show the name and type of service. The central part displays the ports that the service is serving and the target port that the service is pointing to. If the port has been forwarded, a forward button will appear. This button is clickable and will navigate to the HTTP forwarded service.

<figure><img src="/files/86XHF3FX86iMjclqgBl5" alt=""><figcaption></figcaption></figure>

3. **Ingress:** The ingress object is color-coded in green, similar to other network objects. The tile contains the name of the ingress, and within the body, we can see the various paths and the ports they are pointing to.

<figure><img src="/files/3602WXlGgiMc1QcGWxDk" alt=""><figcaption></figcaption></figure>

3. **PVCs:** The Persistent Volumes Claim object and any store object are color-coded in purple. The Title will show the name of the PVC. The main bottom part shows 3 main things:
   * The accessModes
   * The capacity&#x20;
   * The status: Bound or Unbound

<figure><img src="/files/fcfgTJtfcdUajqsE34Y8" alt="" width="202"><figcaption></figcaption></figure>


# Interacting with the Deployment View

Here is a demo video on how to interact with the K8studio Deployment view to CRUD objects in a Kubernetes cluster.

{% embed url="<https://www.youtube.com/watch?v=neLQGXQkkbc>" %}

1. **Adding:** Adding an object to a cluster is easily done in the deployment view. Choose an object type in the Object Sidebar, and drag and drop to a namespace or a subgroup of a namespace.

<figure><img src="/files/VXYYE5pC8AWY1Gj3mcl9" alt=""><figcaption><p>Object bar</p></figcaption></figure>

2. **Editing:** Editing objects in the deployment view is done by selecting and object and using the side editor.

{% content-ref url="/spaces/MXXfpTvt6Xe4Y0tCwViA/pages/02Z7x1LG5yfT1Wi24bvs" %}
[Side Editor](/documentation/side-editor)
{% endcontent-ref %}

3. **Deletion:** Deletion is accomplished by selecting an object and clicking on 'delete' in the cluster detail toolbar.

{% content-ref url="/spaces/MXXfpTvt6Xe4Y0tCwViA/pages/2zewS0JFwVKoVFkWZdY2" %}
[Cluster Detail Toolbar](/documentation/cluster-detail-toolbar)
{% endcontent-ref %}


# Linking Services,Ingress and PVC

Going beyond pure CRUD of objects, the deployment view has a set of helpers that allow us to establish connections between objects. When we select an object, a plus button appears at the top and bottom of the object. Clicking this button opens the appropriate dialog to create an interconnection. The types of connections we are referring to are as follows:

<figure><img src="/files/zoXcwDGhmsIAT1W7ugHl" alt=""><figcaption></figcaption></figure>

* **Connect Ingress with Service**: This helper makes it easy to connect an Ingress with a Service. In the helper form, you can choose any of the available services on the cluster. Once you have chosen a service, you can select from the available service ports and define the host, port, and TLS that the Ingress is going to use to create a rule.

<figure><img src="/files/84tzSjknshVQbcpsQu1l" alt=""><figcaption></figcaption></figure>

* **Connect Service with Ingress:**  This helper will help you to make a connection between a service and an ingress.In the helper form, you can choose any of the available ingress on the cluster. Once you have chosen a ingress, you can select from the selected service ports and define the host, port, and TLS that the Ingress is going to use to create a rule.

<figure><img src="/files/nJ9SbboYjAqnKZaQ9Fyo" alt=""><figcaption></figcaption></figure>

* **Connect Service with a Workload:** In this helper form, you can choose any of the available workloads in the cluster. Once you have selected a workload, you can then choose from the available workload ports to determine which one you want your service to connect to, using the workload port as the target port, and allowing you to define the service port.

<figure><img src="/files/YGoKpJOCVCnSS2SF20ug" alt=""><figcaption></figcaption></figure>

* **Connect Workload with Service:** In this helper form, you can choose any of the available services in the cluster. Once you have selected a services, you can then choose from the available workload ports to determine which one you want your service to connect to, using the workload port as the target port, and allowing you to define the service port.

<figure><img src="/files/T4zLyHMr5Eh5x3UBSSLW" alt=""><figcaption></figcaption></figure>

* **Connect Workload with a PVC (Persistent Volume Claim):** This helper window allows you to connect a volume with a workload. You can specify the type of volume (PVC, Config Map, or Secret), the name of the volume, the container to mount, and the mount path. In the case that you choose a PVC, you can also define the capacity, storage class, and the access mode.

<figure><img src="/files/pcLytTy9fseD1kI41JQn" alt=""><figcaption></figcaption></figure>


# Grid View

<figure><img src="/files/eemkoL64Wwr3mAGEAn2E" alt=""><figcaption><p>Grid View</p></figcaption></figure>

To access the grid view, click on the "Grid" tab on the cluster bar once you are on the cluster detail page.&#x20;

The grid view has a left-hand panel containing all available Kubernetes object types grouped by functionality, including CRDs.&#x20;

To display a specific type of object on the grid, simply select the object type you want to see from the left-hand panel.

<figure><img src="/files/YV1TFq1hLwMyXDHM5qol" alt="" width="204"><figcaption><p>SideBar Catalog</p></figcaption></figure>

&#x20;Once the data is displayed on the grid, users can sort by multiple columns, and create queries filtered by column, and columns are also movable and resizable.

<figure><img src="/files/QFpFC2XP8QmCf1YId8ae" alt="" width="375"><figcaption><p>Multi sort</p></figcaption></figure>

<figure><img src="/files/bb72E31pX3FtPNnTI3Mw" alt="" width="312"><figcaption><p>Column Filter</p></figcaption></figure>

To search across all columns, the grid view provides a search bar on the grid header.&#x20;

To add a new object of the selected type, simply click on the "Add" button on the header bar.

<figure><img src="/files/5d1n3wppR9UG3N4xsIko" alt=""><figcaption><p>Grid header bar</p></figcaption></figure>

To update or delete an object, select the row containing the object and use the side editor to make any modifications.

{% content-ref url="/pages/02Z7x1LG5yfT1Wi24bvs" %}
[Side Editor](/documentation/side-editor)
{% endcontent-ref %}


# Side Editor

When we select an object in the DataGrid or in the Deployment View, the side editor appears to guide us in interacting with the selected object. The side editor provides two main functionalities::thumbsup:

1. Editing: With the YAML and Quick Editor, we can edit any objects and their properties.

{% content-ref url="/spaces/MXXfpTvt6Xe4Y0tCwViA/pages/GNk2SZBjEcR9LgFg7yPQ" %}
[YML Editor](/documentation/side-editor/yml-editor)
{% endcontent-ref %}

{% content-ref url="/spaces/MXXfpTvt6Xe4Y0tCwViA/pages/ucvFwSkj9on2dN7RQkUq" %}
[Quick Editor](/documentation/side-editor/quick-editor)
{% endcontent-ref %}

2. Information: The Quick Editor and the Logs & Events tabs provide us with information about the objects and their status.

{% content-ref url="/spaces/MXXfpTvt6Xe4Y0tCwViA/pages/ucvFwSkj9on2dN7RQkUq" %}
[Quick Editor](/documentation/side-editor/quick-editor)
{% endcontent-ref %}

{% content-ref url="/spaces/MXXfpTvt6Xe4Y0tCwViA/pages/t1HZZq5AAw6vDORZHwRE" %}
[Logs & Events](/documentation/side-editor/logs-and-events)
{% endcontent-ref %}

3. Monitoring: The performance monitor gives us information about CPU, Memory, Network, and  Disk IO.

{% content-ref url="/spaces/MXXfpTvt6Xe4Y0tCwViA/pages/1kRJA693ff3dznvQFP7s" %}
[Metrics](/documentation/side-editor/metrics)
{% endcontent-ref %}


# YML Editor

<figure><img src="/files/KWriygj2qgH3nPhKybcA" alt="" width="563"><figcaption></figcaption></figure>

K8studio provides a full YAML editor that provides the following functionalities :thumbsup:

1. **Syntax highlighting:** Highlights different elements of YAML syntax, such as keys, values, comments, etc., making it easier to read and edit YAML files.
2. **Auto-indentation:** Automatically indents lines to maintain proper YAML structure, improving code readability.
3. **Code folding**: Allows collapsing sections of YAML code to focus on specific parts of the file, reducing clutter and improving navigation.
4. **Error highlighting:** Identifies syntax errors and highlights them for easy detection, helping users correct mistakes efficiently.
5. **Validation:** Checks the YAML file against a schema or predefined rules to ensure it adheres to the correct format and structure.
6. **Find and replace:** Allows searching for specific text or patterns within the YAML file and replacing them as needed, enhancing productivity. To trigger the Find replace Dialog type **Command+F** or **Alt +F**

To save any changes to the cluster once the object is edited you just need to click on the Save Button on the cluster Details bar,&#x20;

To cancel changes and get a fresh copy of the object with the new information you will need to click on the Cancel button.


# Quick Editor

<figure><img src="/files/XfQ4PCXNyCDQcMIQA7Yw" alt="" width="375"><figcaption></figcaption></figure>

The Quick Editor serves as an efficient tool for editing crucial aspects of any object, providing a streamlined approach to accessing key information within an object.

The Quick Editor has the following sections:

1. **Main section**: this section allows us to edit the name and the namespace of an object with an easy and intuitive form.

<figure><img src="/files/VzzhN8OPdDiQnyPwLjiY" alt="" width="345"><figcaption></figcaption></figure>

2. **Labels**: Allows us to edit the labels of an object:

<figure><img src="/files/a8juHGBSwXAlgnm3OWli" alt="" width="304"><figcaption></figcaption></figure>

3. **Spec**:(only for Workloads): Allows us to edit the different sections of the spec of a workload:

<figure><img src="/files/oAquigQHkz0kK5c4Ugkw" alt="" width="304"><figcaption></figcaption></figure>

4. The number of replicas:  Here we can change the number of replicas requested, also this form has a mini graph showing the status of the pod requested:
5. The Selectors: Here we can edit the workload selector Labels:
6. The Template
   1. The Template Labels:
   2. The containers of a template
      * **Container Editor**: Here we can choose the name of the container and the image. The images also have a Docker registry button that, when pressed, shows us the Docker registry dialog to help us search and find the right image and version.
      * **Container Port:**
      * **Container Volume**:
      * **Container Environment variables:**
      * **Container Command**: arguments to execute by the container

<figure><img src="/files/uUneH3ZCzgGHpECAzxLr" alt=""><figcaption></figcaption></figure>

4. Volumes: (only for workloads ) Let us edit and display the different volumes "PVC, Config Map, or Secret" attached to an object

<figure><img src="/files/ozxbItvvQxF71DXE6iPO" alt=""><figcaption></figcaption></figure>

5. Ports:(only for services) This editor enables users to add pods and target ports to a service. Additionally, it includes a helper to facilitate port forwarding for accessing the service from outside the cluster.

<figure><img src="/files/ldukaOwmZhVCM7Qx68iH" alt="" width="406"><figcaption></figcaption></figure>

5. Rules:(only for ingress)
6. TLS:(only for ingress)
7. Cron Options:(only for CronJobs) Allow and help to set all of the options of a cronJob.

<figure><img src="/files/YfOkRcVCi5EZihRzZoQ4" alt="" width="407"><figcaption></figcaption></figure>


# Logs & Events

<figure><img src="/files/EiaJuhqcIk8gn2nZD8iX" alt="" width="259"><figcaption><p>Logs and events</p></figcaption></figure>

The "Log and Event" tab in the side editor combines a view of the status and events related to the selected objects. The status is read from the `status.conditions`, and the events are sourced from the Kubernetes Event stream that are related to the selected objects.


# Metrics

The Metrics tab is only available if Prometheus is installed and properly configured in the cluster settings. Refer to the cluster settings to see how this configuration is set.

{% content-ref url="/spaces/MXXfpTvt6Xe4Y0tCwViA/pages/hoUQjKk3OgX8WJ2r2iu0" %}
[Cluster Setting](/documentation/cluster-manager/cluster-setting)
{% endcontent-ref %}

Once is set up the metric tab is only available for two types of objects Workloads and Nodes.

For WorkLoad the following graphics and metrics are available:

* **Memory Usage:**

<figure><img src="/files/GEBwCkbsNrFOxkWf4ATV" alt="" width="400"><figcaption></figcaption></figure>

* **CPU:**

<figure><img src="/files/pXMeGFoLPuQvZjF1a0rY" alt="" width="398"><figcaption></figcaption></figure>

* **Network:**

<figure><img src="/files/iPM1ZywuRf7r12XUrdtJ" alt="" width="385"><figcaption></figcaption></figure>

* **Disk I/0:**

<figure><img src="/files/ePzNQBx4zyUhHhsYPb5f" alt=""><figcaption></figcaption></figure>

For Nodes, these are the following graphs and metrics:

The Memory graph shows the Allocable and capacity memory of the node, as well as the workload usage and total usage of memory

<figure><img src="/files/7dwD99fTtiP5YeK4eYIv" alt=""><figcaption></figcaption></figure>

The CPU graph shows the Allocable,capacity  and total usage of CPU for a node.


# Action bar

<figure><img src="/files/Oyp3rf1RsYUXGZUdwNMZ" alt=""><figcaption></figcaption></figure>

The action bar provides 4 main functionalities:

* Delete: Use the delete button if you want to remove an object from your cluster.
* SSH(*Only for Pods*): Open a terminal and connect via SSH to the selected pod container.
* LOGS(*Only for Pods*): Open a terminal and retrieve the logs for the selected pod container.
* Unselect: Unselect the selected object and close the side Editor.


# Node View

<figure><img src="/files/mXbUmXzxvX355XGmBFbZ" alt=""><figcaption></figcaption></figure>

The Node View provides visibility into the activity within our cluster at the node level. We can monitor CPU and memory allocation, as well as the available capacity for hosting pods on each node. When selecting a node, we have access to three main components:

* Quick Editor: The Quick Editor provides a concise overview of key information regarding the selected node, including its CIDRs, status, and configured taints. Additionally, it grants access to two essential functions: "Cordon/Uncordon Node" and "Drain Node," allowing for the management of hosted pods.

<figure><img src="/files/sZDsLDKXESKgdkOp23tK" alt="" width="241"><figcaption></figcaption></figure>

* Yml: Grant access to the YAML definition of the node along with its current status.
* In Detail Metrics: In the Detail Metrics section, you'll find comprehensive information regarding CPU and memory metrics.


# Helm View

<figure><img src="/files/EfY7bRzsxCXm3XDuPivT" alt=""><figcaption><p>Helm View</p></figcaption></figure>

The Helm view assists us in managing the available Helm repositories and charts in our system, allowing us to create releases and manage them effectively. The documentation is divided into two main sections: Charts and Repositories, and Manage Releases.

{% content-ref url="/pages/OUj9dohk8OkgW6AIkbGM" %}
[Repositories and Charts](/documentation/helm-view/repositories-and-charts)
{% endcontent-ref %}

{% content-ref url="/pages/teXx2WiOC11i8jogLISu" %}
[Releases](/documentation/helm-view/releases)
{% endcontent-ref %}


# Repositories and Charts

The first time we open the Helm View, the Chart Tab is selected. On the left panel, we can see all the available charts present in the system. In the center, when we select a chart, we can view its documentation. On the right, we have the Install panel where we can choose the release name, the namespace where to install the chart, and the version that we want to install. Additionally, there's a YML editor with all the values that we can change to customize our release.

<figure><img src="/files/EfY7bRzsxCXm3XDuPivT" alt=""><figcaption></figcaption></figure>

**Managing repositories:**

To manage repositories, simply click on the plus button located on the header of the chart list view. This action will display the Helm Repositories dialog, which you can use to manage the installed repositories.

<figure><img src="/files/M98jT4OLLfqdMCsBT1o7" alt=""><figcaption></figcaption></figure>

To add a repository, click on "Add" and define the name and URL location of the repository. To delete a repository, select the repository and click on "Delete."

**Find a chart and create a Helm release:**&#x20;

he Helm view primarily facilitates the installation of charts. To locate the desired chart, you can utilize the search bar in the chart list. Upon finding it, clicking on the row automatically displays the documentation in the center panel, along with the Install panel containing all the chart value options.

To install the chart, provide your release with a name, select a namespace, and choose the chart version. Utilize the YAML editor to set custom values for your YAML chart. Once you're satisfied with the configuration, click on "Deploy" to proceed with the installation.

<figure><img src="/files/sKc6qUCoDuf3VVBnKZ5K" alt=""><figcaption></figcaption></figure>


# Releases

<figure><img src="/files/q7XfTAWipdFrpOhgheWz" alt=""><figcaption></figcaption></figure>

**Exploring Releases**\
If we select the release, the application will display all the installed releases in the left panel. Select a release from the grid to get more information. Once a release is selected, in the center panel, we can see three main pieces of information:

1. Notes: This section shows the available notes from the released chart.
2. Resources: This section contains all of the Kubernetes resources deployed as part of the release.
3. History: This section contains the history and revisions of the different deployments of the release.

On the right, in the YAML editor, we can also see the values for the configuration of the release and the default values for the chart.

**Delete:**

To delete a release, select the release you want to delete, then click on the delete button located on the central information panel.

**Rollback**

To rollback a release to a previous version, click on the rollback button, and in the rollback dialog, select the version you want to rollback to.

<figure><img src="/files/i5wANmTrew6P80apZnzq" alt=""><figcaption></figcaption></figure>

**Update**

To update a release, select the release you want to update and navigate to the right panel. Here, you can change the name, namespace, and chart values to customize your release. Once you're ready to proceed with the update, click on the "Update" button.

<figure><img src="/files/EGA5xH5lFuRbZs9vGlOx" alt=""><figcaption></figcaption></figure>


# RBAC View

<figure><img src="/files/m45CzqzfbcgFYGwG5UdQ" alt=""><figcaption><p>Rbac view</p></figcaption></figure>

For streamlined management of Users, Groups, and Service Accounts, as well as Roles, Cluster Roles, and their respective bindings, K8Studio offers a dedicated view. The documentation is divided into two parts: managing users and their bindings, and the creation of roles and cluster roles.

{% content-ref url="/pages/v6plBaRyGyalRzZHbWJc" %}
[Managing Users](/documentation/rbac-view/managing-users)
{% endcontent-ref %}

{% content-ref url="/pages/oSaMNwhSZcCqelhiJf64" %}
[Broken mention](broken://pages/oSaMNwhSZcCqelhiJf64)
{% endcontent-ref %}


# Roles and Cluster Roles

**Adding Roles or Cluster Roles**

To add a Role or a Cluster Role, begin by selecting the "Roles" tab on the RBAC View. Then, on the left panel where the list of all existing roles and cluster roles is displayed, click on the plus button located on the header of the list.

<figure><img src="/files/0gNWHWUrWLcMmZ9Rd5Ae" alt=""><figcaption></figcaption></figure>

The Add Role Dialog will appear. Depending on your preferences, choose from the options "Role" or "Cluster Role." Set a name, and if you're selecting a Role, you'll also need to choose a namespace. Click on "Add," and your Role or Cluster Role will be created.

<figure><img src="/files/U0dV0MTB2mDvoC4MqUmO" alt=""><figcaption><p>Add Role</p></figcaption></figure>

**Defining Permissions:**

To set the permissions in a Role or Cluster Role, navigate to the central panel called "Permissions."

Click on the "Add" button to add a new permission. Then, use the inline editor to define the namespace, resources, API group, as well as the verbs that the permission allows (create, update, patch, delete, etc.).

To delete any permissions, select the row on the grid and click on the delete button.&#x20;

Any changes made using the permission editor will be reflected in the YML Editor at the bottom, or vice versa. Any CRUD operations on the permissions can be directly performed in the YML editor at the bottom. This will also synchronize the permission editor, ensuring consistency between the two interfaces.

<figure><img src="/files/lVjLvmdhx0MyFLfQfEsp" alt=""><figcaption><p>Role / Cluster Role Permissions</p></figcaption></figure>

**User Usage:**

One useful view located on the far right of the screen is the user section. Once a role or cluster role is selected, this section will display any user, group, or service account that has a binding to the selected role or cluster role.


# Managing Users

**Adding Users:**

To add users, groups, or service accounts, go to the "User" tab on the RBAC view and click on the "Add" button. This action will bring up the Add User modal.

<figure><img src="/files/DD47TIdf8O3S2EK7QPoX" alt=""><figcaption></figcaption></figure>

To create a user, choose "User" on the radio group, enter a name in the name input field, and optionally select any role or cluster role you wish to bind to the user.

<figure><img src="/files/0DQSAOqxfPCGyBlOeFyZ" alt=""><figcaption><p>Adding User</p></figcaption></figure>

**Adding Groups:**

To create a Group, follow the same steps as creating a user. The only difference is that you will select "Group" on the radio group of the Add Modal.

**Adding Services Accounts:**

To create a Service Account, click on the "Add" button on the user tab. Once the Add modal is displayed, select the "Service Account" option on the radio group, define a name, select a namespace where to create the service account, and choose any role or Cluster role that you want to bind the Service Account to.

<figure><img src="/files/fKcc1274VlZz5Or5jFDm" alt=""><figcaption><p>Adding Service account</p></figcaption></figure>

**Delete:**

To delete a user, group, or service, simply select the element you wish to delete from the list and then click on the delete button.

**Search:**

To locate a user, group, or service account, utilize the search bar to swiftly find the desired item.

**Binding Roles and Cluster Roles to a user, group, or Service Account:**

First, select a user, group, or service account. Then, navigate to the User Roles section in the middle of the screen. Here, you'll find all the role and cluster role bindings for the selected user, group, or service account. If you wish to bind any additional role or cluster role to the user, click on the plus button, and the Role Cluster Role Binding modal will appear.

<figure><img src="/files/850R1qUCS8iVPrGI7xbi" alt=""><figcaption><p>Add bindings</p></figcaption></figure>

Choose the roles/cluster roles you wish to add, then click on the "Add" button. K8Studio will create all necessary bindings accordingly.

**Delete user bindings**

After selecting a user, group, or service account, navigate to the Users Roles panel in the center of the screen. Here, you'll find a list of all available bindings for the selected item. Choose the bindings you wish to delete, then click on the delete button to remove them.

<figure><img src="/files/EfdFMNqiD7fiFFn58DJ2" alt=""><figcaption></figcaption></figure>

**User Permission View.**

This view provides a combined overview of the permissions granted by the different bindings to a user, group, or service account. It allows us to easily understand the permissions assigned to a user.

<figure><img src="/files/bHF4zgelu2oMBxu53V02" alt=""><figcaption><p>Permissions View</p></figcaption></figure>


# Metrics


# Node Metrics

To get the node metric running the metric service needs to be installed in the current Cluster

To be able to monitor the node metrics,&#x20;

1. Go to the NodeView.
2. Select a node&#x20;
3. On the side editor select the metric tab

<figure><img src="/files/mXbUmXzxvX355XGmBFbZ" alt=""><figcaption></figcaption></figure>


# Workload Metrics

To enable workload metrics in K8Studio, Prometheus must be installed on the cluster.&#x20;

Once Prometheus is installed, we need to configure K8Studio to recognize the service port and namespace that provides the Prometheus data. This is done by opening the cluster settings and selecting the "Metric Services" option.

<figure><img src="/files/2uc761TB7stJqvIDNB24" alt=""><figcaption></figcaption></figure>

\
To view the Prometheus metrics, select any workload or pod, then navigate to the side editor and choose the "Metric" tab.

<figure><img src="/files/XrHqyqbVEYM7tuANFMiY" alt=""><figcaption></figcaption></figure>


# Cluster Detail Toolbar

<figure><img src="/files/mvk4oLmlcXBwFziIm1bk" alt=""><figcaption></figcaption></figure>

The cluster toolbar has 5 main groups of functionality:

* **View**: The view group allows one to switch between these different views.
  * Deployment:&#x20;
  * Grid
  * Node
  * Helm
  * RBAC
* **Main**: The main groups give us access to
  * **Home**: Go back to the cluster manager view.
  * **Permissions:** Show the permissions that the users have.
  * **Settings:** Open the current cluster settings.
* **Search**: Allows to search items in the deployment view.
* Actions:
  * **Push all:** Save a push to the server for all of the uncommitted changes.
  * **Reload from Cluster:** Get a new copy of all the objects from the server.
* Namespace Filter: Allow the user to select what namespaces are all the views filtered by. All means that all namespaces are visible.


# Terminal

<figure><img src="/files/jViwJGFtUjHZQMF6U0Sa" alt=""><figcaption><p>Terminal</p></figcaption></figure>

To open a terminal after selecting a cluster, it can be done in three different ways:

1. Using the application Menu:

<figure><img src="/files/i1NBWUcwv06gvaH0M9QO" alt=""><figcaption></figcaption></figure>

2. When selecting a Pod and click on SSH:&#x20;

Using the side editor, the user can click on "SSH" to connect to the selected Pod via SSH. If the Pod has more than one container, a modal will appear to choose which container to connect to.

<figure><img src="/files/bj4YH4nbE6n33rgVLRvr" alt=""><figcaption></figcaption></figure>

3. When selecting a Pod and click on LOG: \
   We open a terminal that displays the logs of the selected Pod. If the Pod has more than one container, a modal will appear to choose which container to connect to.

   <br>

The K8studio terminal provides the following functionality.

* Download content.
* Copy selection.
* Open a new terminal
* Selected bash to use in the terminal:

<figure><img src="/files/ZDauof3eqEIqGTYZGAMd" alt=""><figcaption></figcaption></figure>

* Search text in the content of the terminal.

<figure><img src="/files/VuIkxFzuiHqdIUgbHXvr" alt=""><figcaption></figcaption></figure>


# Data Collection and Retention

**Cluster Data Collection:**&#x20;

At K8Studio, we prioritize the privacy of our customers. Thus, we do not gather any cluster information, metrics, or statistics.

**User and Account Data Collection:**&#x20;

K8Studio exclusively collects essential account details, including user information and securely hashed passwords, as well as license and invoice information.

**Website Data Collection:**&#x20;

Our website strictly gathers Google Analytics data only upon user consent to our cookies policy. We do not collect any additional information beyond this.

**Data Retention:**

&#x20;Users have the option to delete their accounts at any time. We commit to retaining only essential accounting data, such as subscriptions and invoices, generated by the user. All other personal data will be promptly and permanently removed from our database upon account deletio