Features
Cluster Management

Cluster Management

The Cluster Management feature is the heart of Skycloak, allowing you to create and manage your Keycloak clusters efficiently. From here, you can view your clusters along with the amount of realms and users, access the Keycloak console, view logs, and request advanced features.

Managing Clusters

Creating a New Cluster

  1. Navigate to the Clusters page
  2. Click “Create a Cluster” button Create a cluster
  3. Configure your cluster:
    • Name your cluster
    • Choose cluster size
    • Select Keycloak version Keycloak version
    • Set admin credentials
  4. Click “Create” for the process to begin

Your cluster will be in “Creating” state for a few minutes, and you’ll receive an email notification when it’s ready. If it takes longer than 5 minutes, please contact us.

Cluster Creating

Accessing the Keycloak Console

  1. From your clusters list, find the cluster you want to access Clusters
  2. Click the “Go to Console” button Go to Console
  3. You’ll be redirected to your Keycloak administration console in a new tab

Cluster Details

Click the “Details” button on any cluster to access: Cluster Details

  • Cluster information
  • Performance metrics
  • Advanced features
  • Logs access

Accessing Cluster Logs

  1. Navigate to cluster details
  2. Click “Request Logs” button
  3. A request will be processed to gather your logs
  4. You’ll receive an email within minutes containing your cluster’s Keycloak logs

Requesting Additional Features

From the cluster details page, you can request:

  • Advanced security features (firewalls)
  • Custom domain setup
  • Custom theme implementation
  • Other specialized configurations

Simply click the “Contact Us” button in the relevant section to submit your request. Request Features

Cluster Operations

Updating a Cluster

  1. Access cluster from dashboard or details page
  2. Click “Edit” button
  3. Choose new configuration options. You are currently limited to changing the cluster name and version.

Important Version Upgrade Notes:

  • Version updates are only allowed to move forward (e.g., 21.0.1 to 21.0.2 or 21.1.0)
  • Downgrading to a lower version is not possible due to database schema compatibility issues
  • For major version upgrades, we recommend upgrading gradually through minor versions
  • Use our Keycloak Upgrade Assistant GPT to help plan your version upgrade path
  1. Click “Update” button
  2. Your cluster will be updated within a few minutes and you will receive an email notification.

Deleting a Cluster

  1. Access cluster dashboard or details page
  2. Click the checkbox to give your consent to delete the cluster
  3. Enter the name of the cluster to confirm deletion
  4. Click “Schedule Deletion” button

Note: This will schedule the deletion of the cluster and you will receive an email notification when it’s done. For data protection purposes, we will keep your cluster’s data for 7 days before deleting it. You will be notified and warned days before deletion. Once deleted, any users from that cluster will be deleted along with the cluster.

Schedule Deletion

You can also cancel the deletion of the cluster if you change your mind at any time before it’s deleted.

Event Viewer