Getting Started with Excalibur v4¶
Welcome to Excalibur v4 — your modern Streamed Access Management (SAM) solution. This guide helps you choose the right deployment model for your organisation, and then get your environment up and running.
Supported Installation Types¶
Excalibur supports the following deployment models:
Kubernetes (SaaS)¶
-
Excalibur is offered as a fully managed SaaS environment — ideal if you want to focus on using the platform without managing infrastructure.
-
The underlying infrastructure is Kubernetes-based and maintained either by Excalibur or by an approved partner.
-
Use this model if you prefer minimal operational overhead, automatic updates, and scalability handled for you.
-
For detailed installation instructions, please refer to the SaaS Installation.
Kubernetes (On-Premises or Private Cloud)¶
-
For organisations that want to host Excalibur within their own infrastructure, Excalibur supports installation on Kubernetes (or k3s / OKD / OpenShift) clusters.
-
This model gives you full control over infrastructure, networking, compliance, and availability.
-
Suitable for strict data-sovereignty/regulatory environments.
-
For detailed installation instructions, please refer to the On-Premises Installation.
Docker (Single-Node / Test Only)¶
-
Excalibur can also be deployed as a Docker compose setup (i.e., on a single Docker engine) for testing, proof-of-concept or small scale non-production.
-
For detailed installation instructions, please refer to the Docker Installation.
Warning
-
The Docker single-node model is not supported for production use — it lacks the orchestration, scalability, and resilience of a Kubernetes deployment.
-
Use this model when you need to evaluate the system quickly or run in a lab/test environment.
-
Limitations: Multi-tenant feature and Tunnel-based remote access are not available in this setup.
Which Deployment to Choose¶
Here’s a decision-guide to help you pick:
Deployment Decision Guide
| Use-case | Recommended Model |
|---|---|
| Want minimal infrastructure management, vendor handles patching/upgrades | Kubernetes (SaaS) |
| Need full control (data on-premises, regulatory compliance) | Kubernetes (On-Premises) |
| Want to trial or demo the system quickly on-premises, small single-server deployment | Docker (Test Only) |
| Want a short-term evaluation environment without hosting anything, fully vendor-controlled for approximately 2 months | SaaS – Dedicated Trial Tenant |
System Requirements¶
Before installing Excalibur v4, ensure your environment meets the necessary hardware requirements for Single Node (Docker) or High Availability (Kubernetes), as well as the specific network specifications for On-Premises deployments. These specifications help guarantee smooth performance, reliable operation, and compatibility with supported deployment models.
For detailed requirements, please refer to the System Requirements.
Onboarding & Initial Setup¶
Once the installation (Kubernetes or Docker) is complete, you must configure the instance using the web-based Setup Guide. This process covers licensing, connecting your Identity Store, and registering the first System Administrator.
For a step-by-step walkthrough, please refer to the Initial Server Setup Guide.
Post-Installation Verification¶
After configuration, it is recommended to perform a few key tests to ensure the system is fully operational:
-
Test user invitation: send an invitation to a test email and verify delivery.
-
Complete user registration: ensure the mobile app registration workflow works.
-
Test login: verify authentication via the mobile app / token.
-
Verify PAM access: add a sample PAM target and verify connectivity and session recording (if applicable).
-
If in a Multi-Tenant or High Availability scenario, verify that separate tenants are isolated, that pods/services scale as expected.
For a comprehensive testing checklist, please refer to the Validation and Testing section.