Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md to include microk8s recoverability feutures. #165

Merged
merged 2 commits into from
Nov 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
1. [Deployment Components](kubernetes/README.md#components)
1. [Setting up the data](kubernetes/README.md#taking-care-of-the-medical-data)
1. [Deploying the stack](kubernetes/README.md#configuration)
1. [Stack recovery](kubernetes/README.md#microk8s-automatic-recoverability)
1. [Configuring new users](doc/keycloak/UsersConfiguration.md)
1. [Authorization for new user](doc/keycloak/UserAuthorizations.md)
1. [Backup and Recovery](doc/BackupAndRecovery.md)
Expand Down
28 changes: 27 additions & 1 deletion kubernetes/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Kubernetes Deployment
**# Kubernetes Deployment

## Requirements
### Hardware
Expand Down Expand Up @@ -174,3 +174,29 @@ For a more in-depth guide on deploying Exareme2, please refer to the documentati
```
microk8s helm3 install mip -f /opt/mip-deployment/kubernetes/<PROFILE_CONFIGURATION_FILE> /opt/mip-deployment/kubernetes
```

# MicroK8s Automatic Recoverability

## Overview
MicroK8s is designed for simplicity and resilience. One of its key features is the automatic recoverability of both federated clusters and individual local nodes.

## Automatic Recoverability in Federation
In a federated cluster setup, MicroK8s ensures high availability and fault tolerance. If the master node in a federation faces downtime or operational issues, MicroK8s is designed to automatically recover its state and functionality.

### Key Points:
- **Self-healing Mechanism**: MicroK8s employs a self-healing mechanism that triggers upon detecting issues with the master node.
- **State Restoration**: Automatically restores the master node to its last known healthy state without manual intervention.

## Local Node Recoverability
For individual local nodes, MicroK8s offers a robust recovery process. This process is vital in scenarios where local nodes experience disruptions.

### Key Points:
- **Node Health Monitoring**: Continuous monitoring of node health to quickly identify any disruptions.
- **Automatic Restoration**: On reboot or reconnection, the local node automatically synchronizes and restores its state to align with the federation's current status.

## Recovery Time Frame
The recovery process in MicroK8s, whether for a federation or a local node, typically completes within a brief period.

### Expected Timeline:
- **Minimum Recovery Time**: Approximately 1 minute.
- **Maximum Recovery Time**: Up to 5 minutes, depending on the complexity and scale of the cluster.
Loading