Dedicated Clusters

Dedicated clusters are available with paid plans. These Clusters use isolated compute, network and storage resources. Customers using dedicated clusters can create up to 20 Realms per cluster. If you need more, please contact your account representative or email support@phasetwo.io.

For more information view the Hosting and Pricing pages.

Creating a Cluster

Creating a new cluster can be started in a couple of ways:

1. Visit the create cluster link.
2. From the Overview page and the Clusters page, click Create Cluster in the top right.

At this time, only a Premium cluster can be created via self-serve, for Enterprise clusters, please contact sales@phasetwo.io. We will be releasing the ability to create Enterprise clusters very soon.

You must select a region, select an owning organization, and input a name to identify the cluster, and optionally provide a domain name you wish to use. Choose between Annual or Monthly billing.

Once you have input the required information, you will be sent to Stripe, our payment partner, to set up your billing account and payment method.

Following successful billing setup, you will be returned to the Clusters view while your Cluster is provisioned. This is usually fast, but can take up to 24 hours in some cases. You will be notified by email and in the Clusters view when the Cluster is live.

Regions

Dedicated clusters are currently available in the following regions using the self-service dashboard:

• AWS US East (N. Virginia) us-east-1
• AWS US West (Oregon) us-west-2
• AWS Europe (Frankfurt) eu-central-1

If you wish to launch a dedicated cluster in one of the following regions, we can provision it for you with an additional monthly fee. Please contact sales@phasetwo.io for more information.

• AWS Asia-Pacific (Mumbai) ap-south-1
• AWS Asia-Pacific (Singapore) ap-southeast-1
• AWS Europe (Ireland) eu-west-1
• GCP Asia-Pacific (Jurong West) asia-southeast1
• GCP Europe (St. Ghislain) europe-west1
• GCP South America (São Paulo) southamerica-east1
• GCP US Central (Iowa) us-central1
• GCP US East (South Carolina) us-east1
• GCP US West (California) us-west2

Global clusters

For use cases that require global proximity to users and region failover behavior, we are currently in beta for our global clusters. Global server load balancing provides geographic region affinity and failover to connect your users with the closest, available instances.

These clusters are backed by CockroachDB multi-region clusters, which are hosted and operated by Cockroach Labs. There are two price tiers for global clusters, depending on your use of our shared CockroachDB clusters, or your own dedicated clusters.

Please contact sales@phasetwo.io to talk to us about your global cluster use case.

Custom domains

Support for custom domains is available for all cloud providers. In order to set up a custom domain that you already own, specify the desired domain when creating the cluster or visit the cluster config page for that specific cluster. Go to the Domains tab and add your desired domain.

Following addition of the domain and setup of your cluster, you will need to create 2 DNS records.

1. Validation record for certificates
2. Vanity record for your desired domain.

For all cloud providers use the following format for the vanity:

• Premium: CNAME yourdomain.com TO {cluster_name}.{region}.{cloud_provider}.auth.ac
• Enterprise: CNAME yourdomain.com TO {cluster_name}.{region}.{cloud_provider}.global.auth.ac

If your validation times out, remove the record and re-add it. Values should remain the same so you will not have to update DNS a second time.

Your cluster will be available from your custom domain within 24 hours of correct configuration of the DNS records.

Cluster Resources: Themes and Extensions

Resources, like a theme or extension, can be uploaded to your cluster for deployment to any Realm (deployment) in that cluster.

Note: Premium clusters are limited to a single theme resource and no extensions. Enterprise clusters can have multiple themes and extensions.

Uploading a Theme or Extension

1. Start by visiting the Cluster > Config > Resources tab.

2. If you have not already done so, create a Resource. A resource is a named entity that allows your upload the theme or extension for a specific Keycloak version. Give the name of the resource something recognizable, like theme-customer-1-0-0.

   

3. After the resource is created, you can upload the theme or extension. Activate a specific version, say Keycloak 26 (only major versions are supported) and then click the upload icon. Select your file and upload it. The file must be a .jar file.

   

4. After the upload is complete, your resource is ready to be deployed to your cluster. Click the Update Resources on Cluster button to alert Phase Two staff to trigger loading this resource. Due to the way Keycloak manages themes and extensions, this requires are restart of your cluster (usually a zero-downtime operation). Keycloak staff review all resources before applying them to a cluster to ensure uptime and functionality.

   

5. After the cluster has been restarted, you can visit your Realm (deployment) and select the theme for use. If using an extension, then you will need to configure the extension in your Realm based on the operation of the extension.

Managing Resources

You can disable or enable resources using the power icon in the card. This will activate or deactivate the resource on the cluster. You can remove the resource entirely from your cluster using the trash icon. Disabling is a good way to temporarily remove a resource without deleting it.

Migrating from a shared deployment

If you currently have a free, shared deployment, and you would like to migrate that deployment into your dedicated cluster, this can be done in a one-time operation. This is a batch operation, and will require 24 hours to process, so immediate migrations are not available. Please contact your customer success representative at support@phasetwo.io and indicate the deployment name you want to migrate, the target cluster, and the time you want to initiate the migration.

Using a Cluster

Clusters are used much the same as our shared deployments. You can create up to 20 Realms per cluster.

Creating Deployments in your Cluster

Once your Cluster has been provisioned, you can create Deployments as before, but you will open the create Deployment modal from the Cluster. Access to the admin console for those Realms is the same, using the Open Console link next to each Deployment.

Billing

Access to invoices and ability to change payment information can be accessed in the action menu next to the Cluster. This will take you to Stripe, our payment partner, to access your billing history and update your payment information. This is restricted to users with the appropriate organization roles.

Deleting a Cluster

Clusters that have reached the provisioing or active state cannot be immediately deleted. If you wish to delete your Cluster and end your subscription, you can schedule the deletion. Your cluster will be available until the end of your montly billing period. At that point, there will begin a 7-day grace period where the cluster will be available, and a 14-day grace period where the data will be preserved. Following that, the cluster will be de-provisioned and all data will be purged from our systems for security and compliance reasons.

Refunds

There are no refunds available for subscriptions paid on a monthly basis.

If you have paid annually, and you have more than one month left in your subscription period, you will be refunded a pro-rated amount following the end of the 14-day grace period. This refund will come through your payment method registered with Stripe.

SLA

Please refer to our Service Level Agreement for more information.