The clique web interface in YTsaurus

The web interface is a convenient way to manage cliques. It is suitable for:

• Quick one‑off tasks.
• Visual monitoring of the clique’s status.
• Configuration without writing scripts.
• Quick parameter review enabled by a clear visual structure.

How to open the clique interface

1. In the main menu of YTsaurus, on the left, select Cliques.

2. In the CHYT cliques section, select the required clique from the list or create a new one.

   Note

   To get familiar with the web interface, use the public clique ch_public. This is a publicly accessible clique that runs on every YTsaurus cluster.

Main sections of the web interface

1. Header — displays the clique name.
2. Action buttons — use them to manage cliques.
3. Clique characteristics block — here you can view the clique’s status.
4. Tabs panel — links to the speclet (configuration), ACL, and logs tabs.

Header

The header (1) displays basic information:

• The name of the cluster where the clique is located, and a button to change it.
• The name of section — CHYT cliques.
• Buttons:
  • Add to favourites — add the clique to your favourites.
  • View favourites — view your favourite cliques.
• The clique name.
• The Create clique button for creating a new clique.

Action buttons

On the right, there is an action buttons block (2):

• SQL — go to the web interface for running queries — Query Tracker.
• Start — start the clique.
• Stop — stop the clique.
• Remove — delete the clique.
• Edit speclet — edit the speclet — the clique’s configuration file.

Clique characteristics

Below the header is the clique characteristics block (3). Key parameters:

• Health — shows the operational status of the clique. The parameter can have the following values:

  • Good — the clique is healthy and ready to accept queries.
  • Pending — this is the state before Good, indicating that the clique is waiting to start.
  • Failed — the clique is unavailable due to a failure.

  Note

  When the Health parameter is set to Failed, the Strawberry Controller restarts the Vanilla operation. If the issue is resolved, Health will change to Pending and then to Good, or back to Failed, in which case the controller will try to restart the Vanilla operation again.

• State — the clique state: Active / Inactive. Shows whether the clique is running or stopped.

• Pool — the name of the compute pool, which is a link to pool's web interface.

• Instances, Cores, Memory — the number of instances and computing resources (CPU cores and RAM) allocated to the clique.

• YT operation Id — a link to the YT operation interface that corresponds to the clique.

Other characteristics are for reference only and help to clarify the main metrics and identify the causes of failures.

Tabs panel

Key information about the clique is displayed in block (4) on the tabs:

• Speclet — shows the contents of the YSON document with the clique’s settings (speclet).
• ACL — shows which access permissions to the clique have been granted and for which user groups. For more details, see the Access permissions section.
• Query Logs — opens the query logs table. For more details, see Getting Query Logs.

Useful links

Clique settings