# Cluster Management (Home)

## Overview

This is the default home page for the Management Console UI. It provides a top-level overview of all your added clusters and provides links to take actions for each listed clusters.

### Tile View

<figure><img src="https://content.gitbook.com/content/9sDjF5HJP1bf8TtLcgkk/blobs/7By7UF0p3pTXsgO750o3/cluster-management-tile-view.png" alt=""><figcaption></figcaption></figure>

<table><thead><tr><th width="70">Field No.</th><th width="150">Field/Button Name</th><th>Description</th></tr></thead><tbody><tr><td>1</td><td>Backup summary</td><td>This section presents a summary of the backups which shows the number of backups in each status category.</td></tr><tr><td>2</td><td>Restore summary</td><td>This section presents a summary of the restore which shows the number of restores in each status category.</td></tr><tr><td>3</td><td>Snapshot summary</td><td>This section presents a summary of the snapshots which shows the number of snapshots in each status category.</td></tr><tr><td>4</td><td>Actions</td><td>Pressing the <strong>Actions</strong> button displays a dropdown menu of actions that a user can take in relation to the cluster selected. For more details click <a data-mention href="#actions">#actions</a>.</td></tr><tr><td>5</td><td>Instance name</td><td>This is the name that you have given to your added cluster. These names should always be meaningful, so that a user can instantly recognise one cluster from another.</td></tr><tr><td>6</td><td>License Expiration Date</td><td>A valid Trilio license is required for running backups and it must be available on the system before a scheduled or on-demand backup is triggered. Once a license expiration date is reached, access to previous backups (made with a valid license) is still available. However, no further backups can be made, which creates risk for the user.</td></tr><tr><td>7</td><td>Total</td><td>This shows total number of available resources on the Cluster</td></tr></tbody></table>

### List View

![Management Console overview](https://content.gitbook.com/content/9sDjF5HJP1bf8TtLcgkk/blobs/NPvtYj2TfE7tgZuJIWxL/cluster%20listing.jpeg)

<table><thead><tr><th width="70">Field No.</th><th width="150">Field/Button Name</th><th>Description</th></tr></thead><tbody><tr><td>1</td><td>Name</td><td>This is the name that you have given to your added cluster. These names should always be meaningful, so that a user can instantly recognise one cluster from another.</td></tr><tr><td>2</td><td>Provider</td><td>This is the provider or distribution of the cluster; e.g. GKE or EKS.</td></tr><tr><td>3</td><td>Status</td><td>The value displayed here relates to the status of the cluster. The value can be: <strong>Active</strong> or <strong>Inactive</strong>.</td></tr><tr><td>4</td><td>License Expiration Date</td><td>A valid Trilio license is required for running backups and it must be available on the system before a scheduled or on-demand backup is triggered. Once a license expiration date is reached, access to previous backups (made with a valid license) is still available. However, no further backups can be made, which creates risk for the user.</td></tr><tr><td>5</td><td>Actions</td><td>Pressing the <strong>Actions</strong> button displays a dropdown menu of actions that a user can take in relation to the cluster selected. For more details click <a data-mention href="#actions">#actions</a>.</td></tr><tr><td>6</td><td>New Cluster</td><td>Pressing the <strong>New Cluster</strong> button displays a panel that enables a user to add more clusters. For more details click <a data-mention href="#adding-new-clusters">#adding-new-clusters</a>.</td></tr><tr><td>7</td><td>Setting icon</td><td>This is to adjust the visibility of 'License Expiration Date' column in listing</td></tr></tbody></table>

## Actions

The **Actions** button (field/button 5 in the image above) provides a dropdown menu of actions that a user can take in relation to the cluster selected. Currently the only option available is **License Update,** but this is likely to extend in the future. Follow the guidance below for each of the actions available.

### Actions: License Update

A Trilio license is required for running backups. A valid license must be available on the system before a scheduled or on-demand backup is triggered. To learn more about licensing and different licensing options, refer to [#license-types](https://docs.trilio.io/kubernetes/licensing#license-types "mention"). To update a license for an existing cluster, perform the following actions:

1. Press the **Actions** button which corresponds with the cluster for which you wish to take an action.\
   ![](https://content.gitbook.com/content/9sDjF5HJP1bf8TtLcgkk/blobs/i6owgb5evoIZn9R3WDS9/license-update-1.png)
2. From the menu displayed, select **License Update**. This displays a small window containing:
   * **License Information -** This includes **Licensing Edition** (e.g. Basic or Enterprise), **Capacity** (i.e. number of CPUs supported), **Expiry** (the date and time of license expiration), and **Build Version** (the version of T4K installed).
   * **Update License Key** - button enables a user to update the license.
3. Press the **Update License Key** button.\
   ![](https://content.gitbook.com/content/9sDjF5HJP1bf8TtLcgkk/blobs/VDggmtQjrOJ7CAd9m2iT/license%20information.jpeg)
4. If you are typing the license key manually:

   * Click the **Enter Key**.
   * Provide your key in the **License Key** text field.
   * Click **Update**.

   ![](https://content.gitbook.com/content/9sDjF5HJP1bf8TtLcgkk/blobs/V1NEnnT1BciSq9gf1BIk/update%20license%20key.jpg)
5. If providing the license key via file upload:

   * Click **Upload Key**.
   * Click **Browse** in the **License Key** field.
   * Navigate your local system directories until you locate and select the correct license key file.
   * Click **Update**.

   ![](https://content.gitbook.com/content/9sDjF5HJP1bf8TtLcgkk/blobs/YMR7pyagSmQZp63TwwTU/update%20license%20upload%20key.jpg)

## Adding New Clusters

On the **Cluster Management** (Home) page, users can add and navigate clusters. T4K supports authentication via KubeConfig files and via Dex, which is an identity service IDP plugin for other identity providers. Below is the step-by-step guide to add clusters using LDAP and OIDC (Google SSO) authentications. Refer to documentation [here](https://docs.trilio.io/kubernetes/getting-started/using-trilio/getting-started-with-management-console/navigating-intro/broken-reference) for other authentication methods.

### Adding the First Cluster

1. Log in to the T4K **Management Console**.
2. The **Cluster Management** (Home) tab is displayed by default, which displays a list of TV-enabled clusters.\
   ![](https://content.gitbook.com/content/9sDjF5HJP1bf8TtLcgkk/blobs/8MTu3U2J3qJopoaWef3N/MCM-image-1.png)
3. Click **New Cluster** to add a new cluster.
4. Provide the requested details, like **Name**, **URL**, and **Distribution Type**. For example:

   * Name: democluster1
   * URL: <https://default.k8s-tvk.com/login>
   * Distribution Type: GKE

   ![](https://content.gitbook.com/content/9sDjF5HJP1bf8TtLcgkk/blobs/s2OXSByp64o61sV7iage/MCM-image-2.png)
5. If authenticating the new cluster using Kubeconfig authentication, click on the **Kubeconfig/Credentials** field to browse your local system to select a previously configured Kubeconfig file. Then click **Add**.
6. If authenticating the new cluster using LDAP/OIDC authentication, first make sure that the LDAP option is displayed. If it is, click **Sign-in via LDAP** and then sign in with your LDAP username and password and click **Login**.\
   ![](https://content.gitbook.com/content/9sDjF5HJP1bf8TtLcgkk/blobs/Pub3Uh12hds8e7ZrJvYD/MCM-image-3.png)
7. Following successful sign-in, a green banner displays on your screen with the confirmation **Cluster Added**.
8. On the **Cluster Management** (Home) tab, check that the new cluster (*democluster1*) is now added to the **CLUSTERS** list the UI.

### Adding Subsequent Clusters Using OIDC

1. To add another cluster, repeat steps 1-4 from the previous section (Adding a New Cluster).
2. Click **Sign-in via Google** (OIDC), which will display as an authentication option if it has been configured by the user. Refer to [oidc-ldap-and-openshift-authentication](https://docs.trilio.io/kubernetes/advanced-configuration/management-console/oidc-ldap-and-openshift-authentication "mention").
3. On the login screen displayed, select the Google account that you wish to sign in with. If you are not already logged in to your Google account, you will be prompted to sign in with your Google username and password.\
   ![](https://content.gitbook.com/content/9sDjF5HJP1bf8TtLcgkk/blobs/ZYjs1Imia5dOmdrrxoaa/MCM-image-4.png)
4. Following successful sign-in, a green banner displays on your screen with the confirmation **Cluster Added**.
5. On the **Cluster Management** (Home) tab, check that the new cluster (*democluster1*) is now added to the **CLUSTERS** list the UI.