Skip to content
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
3 changes: 1 addition & 2 deletions api/src/redirectMappings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ export const redirectMaps: Record<string, string> = {
'operator-guide/install-loki': 'https://docs.kuberocketci.io/docs/operator-guide/monitoring-and-observability/install-loki',
'operator-guide/install-reportportal': 'https://docs.kuberocketci.io/docs/operator-guide/project-management-and-reporting/install-reportportal',
'operator-guide/install-tekton': 'https://docs.kuberocketci.io/docs/operator-guide/install-tekton',
'operator-guide/install-velero': 'https://docs.kuberocketci.io/docs/operator-guide/disaster-recovery/install-velero',
'operator-guide/install-velero-add-ons': 'https://docs.kuberocketci.io/docs/operator-guide/disaster-recovery/install-velero-add-ons',
'operator-guide/install-via-civo': 'https://docs.kuberocketci.io/docs/operator-guide/install-via-civo',
'operator-guide/installation-overview': 'https://docs.kuberocketci.io/docs/operator-guide/installation-overview',
'operator-guide/jira-gerrit-integration': 'https://docs.kuberocketci.io/docs/about-platform',
Expand Down Expand Up @@ -116,7 +116,6 @@ export const redirectMaps: Record<string, string> = {
'operator-guide/upgrade-edp-3.9': 'https://docs.kuberocketci.io/docs/operator-guide/upgrade/upgrade-edp-3.9',
'operator-guide/upgrade-keycloak-19.0': 'https://docs.kuberocketci.io/docs/operator-guide/upgrade/upgrade-keycloak-19.0',
'operator-guide/vcs': 'https://docs.kuberocketci.io/docs/user-guide/add-git-server',
'operator-guide/velero-irsa': 'https://docs.kuberocketci.io/docs/operator-guide/disaster-recovery/velero-irsa',
'operator-guide/waf-tf-configuration': 'https://docs.kuberocketci.io/docs/operator-guide/infrastructure-providers/aws/waf-tf-configuration',
'operator-guide/overview-multi-tenancy': 'https://docs.kuberocketci.io/docs/operator-guide/advanced-installation/capsule',
'operator-guide/troubleshooting/overview': 'https://docs.kuberocketci.io/docs/operator-guide/troubleshooting/overview',
Expand Down
2 changes: 2 additions & 0 deletions cspell.config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,8 @@ words:
- passwordfile
- patchset
- patchsetcreated
- persistentvolumeclaims
- persistentvolumes
- petclinic
- pgcrypto
- pgdb
Expand Down
1 change: 1 addition & 0 deletions docs/operator-guide/add-ons-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,3 +214,4 @@ The list of the available Add-Ons:
|Tekton|A flexible and cloud-native framework for building, testing, and deploying applications using Kubernetes-native workflows.|false|
|Tekton-cache||false|
|Vault|An open-source secrets management solution that provides secure storage, encryption, and access control for sensitive data in Kubernetes clusters.|false|
|Velero|An open source tool to safely backup and restore, perform disaster recovery, and migrate Kubernetes cluster resources and persistent volumes.|false|
114 changes: 114 additions & 0 deletions docs/operator-guide/disaster-recovery/install-velero-add-ons.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
---
title: "Install Velero"
description: "Learn how to install Velero for Kubernetes backup, recovery, and migration, covering installation steps, AWS plugin configuration, and basic commands for backup and restore."
sidebar_label: "Install Velero"
---
<!-- markdownlint-disable MD025 -->

# Automated Kubernetes Backup and Restore Workflows With Velero

<head>
<link rel="canonical" href="https://docs.kuberocketci.io/docs/operator-guide/disaster-recovery/install-velero-add-ons" />
</head>

[Velero](https://velero.io/) is an open source tool to safely back up, recover, and migrate Kubernetes clusters and persistent volumes.
It works both on premises and in a public cloud. Velero consists of a server process running as a deployment in your
Kubernetes cluster and a command-line interface (CLI) with which DevOps teams and platform operators configure scheduled
backups, trigger ad-hoc backups, perform restores, and more.

Configuring and installing Velero involves two key steps:

- **Setting up AWS resources** – configuring IAM roles and policies.
- **Installing Velero** – deploying the Velero components into the Kubernetes cluster.

## Configuring AWS IAM Roles and Policies

Velero requires specific IAM permissions to interact with AWS resources. These permissions allow Velero to create and manage EBS snapshots and volumes, as well as read and write backup data to the designated S3 bucket. This policy ensures Velero can perform backup and restore operations within your AWS account.

To simplify the setup, we recommend using the [terraform-module/velero/kubernetes](https://registry.terraform.io/modules/terraform-module/velero/kubernetes/latest) module. This module automates the creation of the necessary IAM roles and policies for Velero. You can find Velero configuration parameters in the [terraform-aws-platform](https://github.com/KubeRocketCI/terraform-aws-platform/blob/master/eks/irsa.tf#L367) repository.

With this configuration, the following IAM role will be created:

- **AWSIRSA_\<ClusterName\>_Velero**: This role will be used by Velero to perform backup and restore operations by managing EBS snapshots and accessing the S3 backup bucket. The attached policy grants Velero the required permissions to perform backup and restore operations in AWS. It includes the following capabilities:

- **EC2 permissions** — allow Velero to create, describe, tag, and delete EBS snapshots and volumes used during backup and restore processes.
- **S3 bucket access** — allows listing the backup bucket and performing read/write operations on objects, including uploading backup data, retrieving it during restores, and deleting or tagging objects as needed.

## Install Velero

To deploy Velero in your Kubernetes cluster, we recommend using the [add-ons approach](https://github.com/epam/edp-cluster-add-ons/tree/main/clusters/core/addons/velero). Here's an example of how to configure values.yaml before installation:

```yaml title="values.yaml"
velero:
# -- Velero service account settings for AWS access via IRSA. Replace the role ARN with your own IAM role.
serviceAccount:
server:
create: true
name: velero-server
annotations:
eks.amazonaws.com/role-arn: "arn:aws:iam::01234567890:role/AWSIRSA_Core_Velero"

# -- Use Kubernetes secrets for AWS credentials (false = use IRSA)
credentials:
useSecret: false

configuration:
# -- Backup storage settings for Velero
backupStorageLocation:
- name: default
provider: aws
bucket: velero-core
prefix: velero
config:
region: eu-central-1
# -- Settings for volume snapshots
volumeSnapshotLocation:
- name: default
provider: aws
config:
region: eu-central-1

# -- Init container to load AWS plugin for Velero
initContainers:
- name: velero-plugin-for-aws
image: velero/velero-plugin-for-aws:v1.13.1
volumeMounts:
- mountPath: /target
name: plugins

# --------------------------------------------
# Velero Schedule: krci
# --------------------------------------------
# Description:
# Creates daily backups of the "krci" namespace
# on weekdays (Monday–Friday) at 13:00 UTC.
# Excludes PersistentVolumes and PVCs,
# does not snapshot volumes,
# stores backups in the "default" location,
# and retains them for 72 hours.
# --------------------------------------------
schedules:
krci:
disabled: true
paused: false
labels:
cluster: core
region: eu-central-1
schedule: "0 13 * * 1-5"
useOwnerReferencesInBackup: false
template:
excludedClusterScopedResources:
- persistentvolumes
excludedNamespaceScopedResources:
- persistentvolumeclaims
includedNamespaces:
- krci
snapshotVolumes: false
storageLocation: default
ttl: 72h0m0s
```
At the end of the file, you will find backup schedule settings that you can use as a template for creating your own schedules.

## Related Articles

* [Associate IAM Roles With Service Accounts](../infrastructure-providers/aws/enable-irsa.md)
114 changes: 0 additions & 114 deletions docs/operator-guide/disaster-recovery/install-velero.md

This file was deleted.

95 changes: 0 additions & 95 deletions docs/operator-guide/disaster-recovery/velero-irsa.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can use the Velero tool to restore a platform tenant. Explore the main steps

![Remove keycloak realm](../../assets/operator-guide/delete-keycloak-realm.png "Remove keycloak realm")

2. To restore KubeRocketCI, install and configure the Velero tool. Please refer to the [Install Velero](install-velero.md) documentation for details.
2. To restore KubeRocketCI, install and configure the Velero tool. Please refer to the [Install Velero](install-velero-add-ons.md) documentation for details.

3. Remove all locks for operators. Delete all config maps that have `<OPERATOR_NAME>-operator-lock` names. Then restart all pods with operators, or simply run the following command:

Expand Down
2 changes: 1 addition & 1 deletion docs/operator-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ The Operator guide is intended for DevOps and provides information on KubeRocket
* **Continuous Integration (CI)** - Covers the setup and configuration of [Tekton](ci/tekton-overview.md).
* **Continuous Deployment (CD)** - This section contains guidelines on how to integrate a mandatory component [Argo CD](cd/argocd-integration.md). Besides, it also contains information on creating [custom pipelines](cd/customize-deploy-pipeline.md), and [deploying RPM packages](cd/deploy-rpm.md).
* **Infrastructure Providers** - Provides information on integrating with various infrastructure providers, including [AWS](deploy-aws-eks.md) and [OpenShift](infrastructure-providers/okd/deploy-okd-4.10.md).
* **Disaster Recovery** - Explains the installation and configuration of [Velero](disaster-recovery/install-velero.md) as a solution for disaster recovery.
* **Disaster Recovery** - Explains the installation and configuration of [Velero](disaster-recovery/install-velero-add-ons.md) as a solution for disaster recovery.
* **Upgrade** - Provides guides on upgrading KubeRocketCI and related components, including historical versions.
* **Troubleshooting** - Includes common troubleshooting guides for various issues that may occur during the setup and operation of KubeRocketCI.
Loading
Loading