# FalkorDB Enterprise

> Install, operate, and scale self-managed FalkorDB on Kubernetes.

## Docs

- [FalkorDB Enterprise](https://docs.enterprise.falkordb.com/index.md): Run FalkorDB as a self-managed, production-grade graph database platform on your own Kubernetes clusters.
- [Platform overview](https://docs.enterprise.falkordb.com/get-started/overview.md): What FalkorDB Enterprise includes, how the components fit together, and when to use it.
- [Requirements](https://docs.enterprise.falkordb.com/get-started/requirements.md): Cluster capacity, local tooling, permissions, and network access needed before you install.
- [Quickstart](https://docs.enterprise.falkordb.com/get-started/quickstart.md): Install FalkorDB Enterprise into any Kubernetes cluster reachable by your current kubectl context.
- [Production install](https://docs.enterprise.falkordb.com/deployment/production.md): Install FalkorDB Enterprise with managed secrets, private images, ingress, TLS, and persistence.
- [Private registries](https://docs.enterprise.falkordb.com/deployment/private-images.md): Pull every image the chart uses from the FalkorDB mirror, or point the chart at your own private registry.
- [External DNS access](https://docs.enterprise.falkordb.com/deployment/external-dns.md): Publish per-pod DNS names so workloads outside the cluster can reach databases directly.
- [Azure Kubernetes Service](https://docs.enterprise.falkordb.com/deployment/aks.md): Provision Azure infrastructure and install FalkorDB Enterprise on AKS.
- [Private AKS install](https://docs.enterprise.falkordb.com/deployment/aks-internal.md): Run FalkorDB Enterprise on AKS with an internal load balancer, Key Vault TLS, and private DNS.
- [Amazon Elastic Kubernetes Service](https://docs.enterprise.falkordb.com/deployment/eks.md): Provision AWS infrastructure and install FalkorDB Enterprise on EKS.
- [Google Kubernetes Engine](https://docs.enterprise.falkordb.com/deployment/gke.md): Provision GCP infrastructure and install FalkorDB Enterprise on GKE.
- [Red Hat OpenShift](https://docs.enterprise.falkordb.com/deployment/openshift.md): Install FalkorDB Enterprise on OpenShift with SCC-compatible security contexts, Routes, and ODF storage.
- [Rancher (RKE2 and K3s)](https://docs.enterprise.falkordb.com/deployment/rancher.md): Install FalkorDB Enterprise on Rancher-managed clusters with Longhorn storage and bundled ingress.
- [Google OAuth](https://docs.enterprise.falkordb.com/authentication/google-oauth.md): Enable Google sign-in and Google Workspace group lookup for role mapping.
- [Microsoft Entra ID OAuth](https://docs.enterprise.falkordb.com/authentication/azure-ad-oauth.md): Enable Microsoft Entra ID (Azure AD) sign-in and Microsoft Graph group lookup for role mapping.
- [Networking](https://docs.enterprise.falkordb.com/databases/networking.md): How FalkorDB deployments are reachable inside the cluster by default, and what it takes to reach them from outside.
- [Standalone deployment](https://docs.enterprise.falkordb.com/databases/standalone.md): Create a single-node FalkorDB deployment from the Admin UI.
- [Replicated deployment](https://docs.enterprise.falkordb.com/databases/replicated.md): Create a multi-node FalkorDB deployment without Sentinel services.
- [Replicated deployment with Sentinel](https://docs.enterprise.falkordb.com/databases/sentinel.md): Create a replicated FalkorDB deployment with Redis Sentinel high availability.
- [Sharded deployment](https://docs.enterprise.falkordb.com/databases/sharded.md): Create a sharded FalkorDB deployment for horizontal data distribution.
- [Deploy from YAML](https://docs.enterprise.falkordb.com/databases/yaml.md): Create a FalkorDB deployment from a raw KubeBlocks YAML manifest.
- [Scale a deployment](https://docs.enterprise.falkordb.com/operations/scaling.md): Scale FalkorDB deployments horizontally and vertically.
- [Parameters and resources](https://docs.enterprise.falkordb.com/operations/parameters.md): Change FalkorDB parameters, network services, CPU, memory, and storage.
- [Backups and schedules](https://docs.enterprise.falkordb.com/operations/backups.md): Configure backup repositories, run on-demand backups, and create recurring schedules.
- [Restore in place](https://docs.enterprise.falkordb.com/operations/restore-same-database.md): Restore a backup into an existing deployment.
- [Restore to a new deployment](https://docs.enterprise.falkordb.com/operations/restore-new-database.md): Create a new deployment from an existing backup.
- [Monitoring and Grafana](https://docs.enterprise.falkordb.com/operations/monitoring.md): View logs, live metrics, and optional Grafana dashboards.
- [Reset the admin password](https://docs.enterprise.falkordb.com/operations/reset-admin-password.md): Recover an admin account by resetting the user Secret in Kubernetes.
- [Upgrade FalkorDB Enterprise](https://docs.enterprise.falkordb.com/upgrades/enterprise.md): Upgrade the FalkorDB Enterprise Helm release safely.
- [Upgrade KubeBlocks](https://docs.enterprise.falkordb.com/upgrades/kubeblocks.md): Upgrade the KubeBlocks platform components used by FalkorDB Enterprise.
- [Upgrade a FalkorDB version](https://docs.enterprise.falkordb.com/upgrades/falkordb-version.md): Update a deployment to a target FalkorDB version.
- [Uninstall](https://docs.enterprise.falkordb.com/upgrades/uninstall.md): Remove FalkorDB Enterprise and, optionally, the platform components it installed.
- [Troubleshoot deployments](https://docs.enterprise.falkordb.com/troubleshooting/deployments.md): Diagnose and fix common issues with FalkorDB deployments managed by KubeBlocks.
- [Support packages](https://docs.enterprise.falkordb.com/troubleshooting/support-package.md): Collect a diagnostics bundle and inspect its contents for support triage.
- [Helm values](https://docs.enterprise.falkordb.com/reference/helm-values.md): High-impact Helm values for the FalkorDB Enterprise chart, verified against the chart defaults.
- [Installer reference](https://docs.enterprise.falkordb.com/reference/installer-flags.md): Command-line options and environment variables for install.sh and uninstall.sh.
- [Command line](https://docs.enterprise.falkordb.com/reference/cli.md): Operate FalkorDB Enterprise from the terminal with the falkordb-admin CLI.
- [Glossary](https://docs.enterprise.falkordb.com/reference/glossary.md): Terms used across the FalkorDB Enterprise documentation and Admin UI.
- [Admin Server API](https://docs.enterprise.falkordb.com/api-reference/introduction.md): Authenticate against the FalkorDB Enterprise Admin Server and call its REST API.
- [KubeBlocks resources](https://docs.enterprise.falkordb.com/api-reference/kubeblocks.md): Reference for the KubeBlocks custom resources behind FalkorDB Enterprise deployments.
- [Health check endpoint](https://docs.enterprise.falkordb.com/api-reference/endpoints/system/health-check-endpoint.md)
- [Readiness check endpoint](https://docs.enterprise.falkordb.com/api-reference/endpoints/system/readiness-check-endpoint.md)
- [List all available Kubernetes namespaces](https://docs.enterprise.falkordb.com/api-reference/endpoints/system/list-all-available-kubernetes-namespaces.md)
- [List all available FalkorDB component versions](https://docs.enterprise.falkordb.com/api-reference/endpoints/system/list-all-available-falkordb-component-versions.md)
- [List all available Kubernetes StorageClasses](https://docs.enterprise.falkordb.com/api-reference/endpoints/system/list-all-available-kubernetes-storageclasses.md)
- [Get aggregated cluster CPU/memory/storage capacity and deployment vs support usage split](https://docs.enterprise.falkordb.com/api-reference/endpoints/system/get-aggregated-cluster-cpumemorystorage-capacity-and-deployment-vs-support-usage-split.md)
- [Get supported authentication methods and their public configuration](https://docs.enterprise.falkordb.com/api-reference/endpoints/authentication/get-supported-authentication-methods-and-their-public-configuration.md)
- [Authenticate user with email and password](https://docs.enterprise.falkordb.com/api-reference/endpoints/authentication/authenticate-user-with-email-and-password.md)
- [Logout current user](https://docs.enterprise.falkordb.com/api-reference/endpoints/authentication/logout-current-user.md)
- [Validate authentication token](https://docs.enterprise.falkordb.com/api-reference/endpoints/authentication/validate-authentication-token.md)
- [Initiate OAuth flow for a configured provider](https://docs.enterprise.falkordb.com/api-reference/endpoints/oauth/initiate-oauth-flow-for-a-configured-provider.md)
- [Handle OAuth callback for a configured provider](https://docs.enterprise.falkordb.com/api-reference/endpoints/oauth/handle-oauth-callback-for-a-configured-provider.md)
- [Handle OAuth callback for the configured provider](https://docs.enterprise.falkordb.com/api-reference/endpoints/oauth/handle-oauth-callback-for-the-configured-provider.md)
- [List all users with optional filtering](https://docs.enterprise.falkordb.com/api-reference/endpoints/users/list-all-users-with-optional-filtering.md)
- [Create a new user](https://docs.enterprise.falkordb.com/api-reference/endpoints/users/create-a-new-user.md)
- [Get a specific user by email](https://docs.enterprise.falkordb.com/api-reference/endpoints/users/get-a-specific-user-by-email.md)
- [Delete a user](https://docs.enterprise.falkordb.com/api-reference/endpoints/users/delete-a-user.md)
- [Update an existing user](https://docs.enterprise.falkordb.com/api-reference/endpoints/users/update-an-existing-user.md)
- [Reset user password](https://docs.enterprise.falkordb.com/api-reference/endpoints/users/reset-user-password.md)
- [Get current user profile](https://docs.enterprise.falkordb.com/api-reference/endpoints/user-profile/get-current-user-profile.md)
- [Change current user password](https://docs.enterprise.falkordb.com/api-reference/endpoints/user-profile/change-current-user-password.md)
- [Get current user activity history](https://docs.enterprise.falkordb.com/api-reference/endpoints/user-profile/get-current-user-activity-history.md)
- [List all backup repositories](https://docs.enterprise.falkordb.com/api-reference/endpoints/backup-repositories/list-all-backup-repositories.md)
- [Create a new backup repository](https://docs.enterprise.falkordb.com/api-reference/endpoints/backup-repositories/create-a-new-backup-repository.md)
- [Get a specific backup repository](https://docs.enterprise.falkordb.com/api-reference/endpoints/backup-repositories/get-a-specific-backup-repository.md)
- [Delete a backup repository](https://docs.enterprise.falkordb.com/api-reference/endpoints/backup-repositories/delete-a-backup-repository.md)
- [Update an existing backup repository](https://docs.enterprise.falkordb.com/api-reference/endpoints/backup-repositories/update-an-existing-backup-repository.md)
- [Get all admin settings](https://docs.enterprise.falkordb.com/api-reference/endpoints/settings/get-all-admin-settings.md)
- [Update admin settings](https://docs.enterprise.falkordb.com/api-reference/endpoints/settings/update-admin-settings.md)
- [Query audit logs with filtering](https://docs.enterprise.falkordb.com/api-reference/endpoints/audit/query-audit-logs-with-filtering.md)
- [Get current RBAC configuration](https://docs.enterprise.falkordb.com/api-reference/endpoints/rbac/get-current-rbac-configuration.md)
- [Update RBAC configuration (full replace)](https://docs.enterprise.falkordb.com/api-reference/endpoints/rbac/update-rbac-configuration-full-replace.md)
- [Reload RBAC configuration from ConfigMap](https://docs.enterprise.falkordb.com/api-reference/endpoints/rbac/reload-rbac-configuration-from-configmap.md)
- [List all RBAC roles](https://docs.enterprise.falkordb.com/api-reference/endpoints/rbac/list-all-rbac-roles.md)
- [Create a custom RBAC role](https://docs.enterprise.falkordb.com/api-reference/endpoints/rbac/create-a-custom-rbac-role.md)
- [Get specific RBAC role by name](https://docs.enterprise.falkordb.com/api-reference/endpoints/rbac/get-specific-rbac-role-by-name.md)
- [Update a custom RBAC role](https://docs.enterprise.falkordb.com/api-reference/endpoints/rbac/update-a-custom-rbac-role.md)
- [Delete a custom RBAC role](https://docs.enterprise.falkordb.com/api-reference/endpoints/rbac/delete-a-custom-rbac-role.md)
- [List all group-to-role mappings](https://docs.enterprise.falkordb.com/api-reference/endpoints/rbac/list-all-group-to-role-mappings.md)
- [Create a group-to-role mapping](https://docs.enterprise.falkordb.com/api-reference/endpoints/rbac/create-a-group-to-role-mapping.md)
- [Update a group-to-role mapping](https://docs.enterprise.falkordb.com/api-reference/endpoints/rbac/update-a-group-to-role-mapping.md)
- [Delete a group-to-role mapping](https://docs.enterprise.falkordb.com/api-reference/endpoints/rbac/delete-a-group-to-role-mapping.md)
- [Get comprehensive system diagnostics](https://docs.enterprise.falkordb.com/api-reference/endpoints/diagnostics/get-comprehensive-system-diagnostics.md)
- [Export diagnostics data as downloadable JSON file](https://docs.enterprise.falkordb.com/api-reference/endpoints/diagnostics/export-diagnostics-data-as-downloadable-json-file.md)
- [Export a compact support diagnostics package for FalkorDB support](https://docs.enterprise.falkordb.com/api-reference/endpoints/diagnostics/export-a-compact-support-diagnostics-package-for-falkordb-support.md)
- [Check system health status](https://docs.enterprise.falkordb.com/api-reference/endpoints/diagnostics/check-system-health-status.md)
- [Get license status and current resource usage](https://docs.enterprise.falkordb.com/api-reference/endpoints/licensing/get-license-status-and-current-resource-usage.md)
- [Activate FalkorDB Enterprise with a signed license](https://docs.enterprise.falkordb.com/api-reference/endpoints/licensing/activate-falkordb-enterprise-with-a-signed-license.md)
- [Get system-wide metrics including CPU, memory, and cluster stats](https://docs.enterprise.falkordb.com/api-reference/endpoints/metrics/get-system-wide-metrics-including-cpu-memory-and-cluster-stats.md)
- [Search across clusters, backups, and users](https://docs.enterprise.falkordb.com/api-reference/endpoints/search/search-across-clusters-backups-and-users.md): Search across clusters, backups, and users. Results are restricted to what the caller has read/list permissions for. Filtering is in-memory because Kubernetes does not support wildcard name searches - only metadata fields (name, namespace, labels) are matched.
- [List all clusters](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/list-all-clusters.md)
- [Create a new FalkorDB cluster](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/create-a-new-falkordb-cluster.md)
- [Get a specific cluster](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/get-a-specific-cluster.md)
- [Delete a cluster](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/delete-a-cluster.md)
- [Update an existing cluster](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/update-an-existing-cluster.md)
- [Retrieve the JSON schema (openAPIV3Schema) for the Cluster custom resource definition](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/retrieve-the-json-schema-openapiv3schema-for-the-cluster-custom-resource-definition.md)
- [Create a new FalkorDB cluster from a raw YAML manifest](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/create-a-new-falkordb-cluster-from-a-raw-yaml-manifest.md)
- [Get the raw YAML of a cluster custom resource](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/get-the-raw-yaml-of-a-cluster-custom-resource.md)
- [Replace a cluster custom resource from YAML](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/replace-a-cluster-custom-resource-from-yaml.md)
- [List all KubeBlocks OpsRequests for a cluster](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/list-all-kubeblocks-opsrequests-for-a-cluster.md)
- [Return audit log events for a cluster](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/return-audit-log-events-for-a-cluster.md)
- [List all pods for a specific cluster](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/list-all-pods-for-a-specific-cluster.md)
- [Get logs from a specific pod](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/get-logs-from-a-specific-pod.md)
- [Stream logs from a specific pod using Server-Sent Events](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/stream-logs-from-a-specific-pod-using-server-sent-events.md)
- [Get aggregated metrics for all pods in a cluster](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/get-aggregated-metrics-for-all-pods-in-a-cluster.md)
- [Get Prometheus metrics from a pod parsed into structured JSON](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/get-prometheus-metrics-from-a-pod-parsed-into-structured-json.md): Get Prometheus metrics from a pod parsed into structured JSON. Each entry has name, help, type, and samples with labels and values.
- [Stream parsed Prometheus pod metrics as Server-Sent Events](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/stream-parsed-prometheus-pod-metrics-as-server-sent-events.md): Stream parsed Prometheus pod metrics as Server-Sent Events. Each event contains the same payload as GET /:name/pods/:podName/metrics.
- [Stream aggregated cluster metrics (CPU & memory) as Server-Sent Events](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/stream-aggregated-cluster-metrics-cpu-&-memory-as-server-sent-events.md): Stream aggregated cluster metrics (CPU & memory) as Server-Sent Events. Each event contains the same fields as GET /:name/metrics.
- [Upgrade a cluster FalkorDB version and/or addon ComponentDefinition](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/upgrade-a-cluster-falkordb-version-andor-addon-componentdefinition.md)
- [Get connection credentials (hostname, port, username, password) for a cluster](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/get-connection-credentials-hostname-port-username-password-for-a-cluster.md)
- [Get Redis runtime configuration (redis.conf) for a cluster](https://docs.enterprise.falkordb.com/api-reference/endpoints/clusters/get-redis-runtime-configuration-redisconf-for-a-cluster.md)
- [Cleanup expired backups for a specific cluster](https://docs.enterprise.falkordb.com/api-reference/endpoints/backups/cleanup-expired-backups-for-a-specific-cluster.md)
- [List all backups for a specific cluster](https://docs.enterprise.falkordb.com/api-reference/endpoints/backups/list-all-backups-for-a-specific-cluster.md)
- [Create a new backup](https://docs.enterprise.falkordb.com/api-reference/endpoints/backups/create-a-new-backup.md)
- [Get a specific backup](https://docs.enterprise.falkordb.com/api-reference/endpoints/backups/get-a-specific-backup.md)
- [Delete a backup](https://docs.enterprise.falkordb.com/api-reference/endpoints/backups/delete-a-backup.md)
- [List all OpsRequests for a cluster](https://docs.enterprise.falkordb.com/api-reference/endpoints/cluster-operations/list-all-opsrequests-for-a-cluster.md)
- [Get a specific OpsRequest](https://docs.enterprise.falkordb.com/api-reference/endpoints/cluster-operations/get-a-specific-opsrequest.md)
- [Delete an OpsRequest](https://docs.enterprise.falkordb.com/api-reference/endpoints/cluster-operations/delete-an-opsrequest.md)
- [Restart cluster component pods one-by-one with a rolling restart](https://docs.enterprise.falkordb.com/api-reference/endpoints/cluster-operations/restart-cluster-component-pods-one-by-one-with-a-rolling-restart.md)
- [Start a previously stopped cluster](https://docs.enterprise.falkordb.com/api-reference/endpoints/cluster-operations/start-a-previously-stopped-cluster.md)
- [Gracefully stop all pods in the cluster](https://docs.enterprise.falkordb.com/api-reference/endpoints/cluster-operations/gracefully-stop-all-pods-in-the-cluster.md)
- [Update runtime configuration parameters (Reconfiguring)](https://docs.enterprise.falkordb.com/api-reference/endpoints/cluster-operations/update-runtime-configuration-parameters-reconfiguring.md)
- [Promote a replica to primary (Switchover)](https://docs.enterprise.falkordb.com/api-reference/endpoints/cluster-operations/promote-a-replica-to-primary-switchover.md)
- [Set the desired total replicas and/or shard count (HorizontalScaling)](https://docs.enterprise.falkordb.com/api-reference/endpoints/cluster-operations/set-the-desired-total-replicas-andor-shard-count-horizontalscaling.md)
- [Adjust CPU and memory requests/limits (VerticalScaling)](https://docs.enterprise.falkordb.com/api-reference/endpoints/cluster-operations/adjust-cpu-and-memory-requestslimits-verticalscaling.md)
- [Expand PVC storage size (VolumeExpansion)](https://docs.enterprise.falkordb.com/api-reference/endpoints/cluster-operations/expand-pvc-storage-size-volumeexpansion.md)
- [List backup policies for a specific cluster](https://docs.enterprise.falkordb.com/api-reference/endpoints/backup-policies/list-backup-policies-for-a-specific-cluster.md)
- [Create a new backup policy](https://docs.enterprise.falkordb.com/api-reference/endpoints/backup-policies/create-a-new-backup-policy.md)
- [Get a specific backup policy](https://docs.enterprise.falkordb.com/api-reference/endpoints/backup-policies/get-a-specific-backup-policy.md)
- [Delete a backup policy](https://docs.enterprise.falkordb.com/api-reference/endpoints/backup-policies/delete-a-backup-policy.md)
- [List all backup schedules for a specific cluster](https://docs.enterprise.falkordb.com/api-reference/endpoints/backup-schedules/list-all-backup-schedules-for-a-specific-cluster.md)
- [Create a new backup schedule](https://docs.enterprise.falkordb.com/api-reference/endpoints/backup-schedules/create-a-new-backup-schedule.md)
- [Get a specific backup schedule](https://docs.enterprise.falkordb.com/api-reference/endpoints/backup-schedules/get-a-specific-backup-schedule.md)
- [Delete a backup schedule](https://docs.enterprise.falkordb.com/api-reference/endpoints/backup-schedules/delete-a-backup-schedule.md)
- [Update an existing backup schedule](https://docs.enterprise.falkordb.com/api-reference/endpoints/backup-schedules/update-an-existing-backup-schedule.md)
- [List all restores for a specific cluster](https://docs.enterprise.falkordb.com/api-reference/endpoints/restores/list-all-restores-for-a-specific-cluster.md)
- [Create a new restore](https://docs.enterprise.falkordb.com/api-reference/endpoints/restores/create-a-new-restore.md)
- [Get a specific restore](https://docs.enterprise.falkordb.com/api-reference/endpoints/restores/get-a-specific-restore.md)
- [Delete a restore](https://docs.enterprise.falkordb.com/api-reference/endpoints/restores/delete-a-restore.md)
- [Clone a cluster from a full backup by creating a new cluster with the restore annotation](https://docs.enterprise.falkordb.com/api-reference/endpoints/restores/clone-a-cluster-from-a-full-backup-by-creating-a-new-cluster-with-the-restore-annotation.md)

## OpenAPI Specs

- [admin-server](https://docs.enterprise.falkordb.com/api-reference/admin-server.json)

## Optional

- [FalkorDB Docs](https://docs.falkordb.com)
- [GitHub](https://github.com/FalkorDB/FalkorDB-Enterprise)
- [Support](mailto:support@falkordb.com)