Cluster settings allow you to monitor connectivity, configure agent behavior, perform maintenance operations, and manage the cluster lifecycle.
Accessing Cluster Settings
- Navigate to your cluster from the sidebar.
- Click Settings in the cluster navigation.
- Select General to access connectivity, agent, and maintenance settings.
Connectivity
Monitor the health of your cluster’s connection to the Ankra platform.Agent Status
The Ankra Agent is a lightweight component deployed in your cluster that enables communication with the platform.| Status | Description |
|---|---|
| Connected | Agent is online and communicating normally |
| Disconnected | Agent is not responding—check your cluster’s network |
| Outdated | A newer agent version is available |
| Error | Agent encountered an issue—check logs for details |
Agent Version
View the currently installed agent version and check if updates are available.Kubernetes Watch Status
The Watch service monitors Kubernetes resources and syncs state to the platform. The status indicator shows:| Status | Description |
|---|---|
| Synced | All resources are synchronized |
| Syncing | Synchronization in progress |
| Error | Sync failed—click to view details |
Agent Settings
Configure how the agent behaves on this specific cluster.Auto-upgrade Agent
Control whether the agent automatically upgrades when new versions are released.| Setting | Behavior |
|---|---|
| Inherit from Organisation | Uses the organisation’s auto-upgrade setting |
| Enabled | Agent upgrades automatically (overrides organisation if disabled) |
| Disabled | Agent stays at current version (opt-out of organisation setting) |
When auto-upgrade is enabled at the organisation level, individual clusters can opt-out. When disabled at the organisation level, clusters cannot enable it.
- Go to cluster Settings → General
- Find the Agent Settings card
- Toggle Auto-upgrade Agent as desired
Maintenance
Perform maintenance operations on your cluster.Generate Import Token
Create a token for re-importing the cluster or connecting from a different location.Sync All Resources
Force a full synchronization of all Kubernetes resources from your cluster to the platform.
When to sync manually:
- After network issues that may have caused missed updates
- When resources appear out of sync in the platform
- After bulk changes to Kubernetes resources outside of Ankra
GitOps Settings
Configure Git repository integration for GitOps workflows.Connecting a Repository
For detailed GitOps configuration, see GitOps.
Webhook Status
Monitor webhook delivery status to ensure Git events trigger deployments:| Status | Description |
|---|---|
| Active | Webhook is configured and receiving events |
| Inactive | Webhook needs configuration |
| Error | Webhook delivery failing—check repository settings |
Metrics Settings
Configure metrics collection for observability features.Prometheus Data Source
Connect an external Prometheus instance to enable metrics visualization in Ankra.
For detailed Prometheus setup, see Prometheus Integration.
Encryption Settings
Configure SOPS decryption for encrypted stacks on this cluster.Enable SOPS Decryption
Allow this cluster to decrypt SOPS-encrypted values during deployment.
For complete SOPS documentation, see SOPS Encryption.
Kubernetes Settings
Monitor Kubernetes resource synchronization status in detail.Accessing Kubernetes Settings
- Navigate to your cluster → Settings → Kubernetes
- View the resource sync status table
Resource Sync Status Table
The sync status table shows synchronization details for each Kubernetes resource type:| Column | Description |
|---|---|
| Resource Type | The Kubernetes resource kind (Deployments, Services, etc.) |
| Status | Current sync state for this resource type |
| Resource Count | Number of resources of this type tracked |
| Last Sync | When this resource type was last synchronized |
| Errors | Number of sync errors (if any) |
Sync Status Values
| Status | Description |
|---|---|
| Synced | All resources of this type are synchronized |
| Syncing | Synchronization is currently in progress |
| Stale | Resources may be out of date—sync pending |
| Error | Sync failed for some resources—check error messages |
| Disconnected | Cluster is offline—sync unavailable |
| Initializing | First-time sync in progress |
Table Features
- Auto-refresh: The table updates automatically every 10 seconds
- Filtering: Filter by resource type or status
- Sorting: Click column headers to sort
- Error Details: Expand error rows to see specific error messages
Offline Cluster Warning
When a cluster is offline, a warning banner appears indicating that Kubernetes settings are unavailable until the cluster reconnects.Refreshing Sync Status
Click Refresh to manually trigger a status update. This fetches the latest synchronization state from the cluster.Variables Settings
Cluster variables apply to all stacks deployed to this cluster. For complete variable documentation, see Variables.Danger Zone
Disconnect Cluster
Remove the cluster from Ankra without affecting running workloads. What happens:- The cluster is removed from the Ankra platform
- Running workloads continue to run
- ArgoCD and other installed components remain
- GitOps synchronization stops
You can reconnect a disconnected cluster by importing it again with a new token.
Deprovision Cluster
Remove Ankra-managed components from the cluster. What is removed:- Ankra Agent
- Ankra-deployed ArgoCD configuration
- SOPS decryption keys
- Your workloads and applications
- Manually installed components
- Kubernetes resources not managed by Ankra
Delete Cluster
Completely remove the cluster from Ankra. Considerations before deleting:- Ensure no active operations are running
- Back up stack configurations if needed
- Inform team members who use this cluster