From e5f630dfa3a33b3d70ad217330b8c9f4b87274e7 Mon Sep 17 00:00:00 2001 From: Kostiantyn Krykun Date: Mon, 1 Dec 2025 10:34:59 +0200 Subject: [PATCH] docs: Update Velero documentation (#319) --- api/src/redirectMappings.ts | 3 +- cspell.config.yaml | 2 + docs/operator-guide/add-ons-overview.md | 1 + .../install-velero-add-ons.md | 114 ++++++++++++++++++ .../disaster-recovery/install-velero.md | 114 ------------------ .../disaster-recovery/velero-irsa.md | 95 --------------- .../velero-restore-platform.md | 2 +- docs/operator-guide/index.md | 2 +- .../aws/enable-irsa.md | 34 +----- .../aws/kaniko-irsa.md | 5 - .../monitoring-and-observability/loki-irsa.md | 4 - package-lock.json | 103 +++++++--------- sidebars.ts | 3 +- .../install-velero-add-ons.md | 114 ++++++++++++++++++ .../disaster-recovery/install-velero.md | 114 ------------------ .../disaster-recovery/velero-irsa.md | 95 --------------- .../velero-restore-platform.md | 2 +- .../version-3.10/operator-guide/index.md | 2 +- .../aws/enable-irsa.md | 34 +----- .../aws/kaniko-irsa.md | 5 - .../monitoring-and-observability/loki-irsa.md | 4 - .../install-velero-add-ons.md | 114 ++++++++++++++++++ .../disaster-recovery/install-velero.md | 114 ------------------ .../disaster-recovery/velero-irsa.md | 95 --------------- .../velero-restore-platform.md | 2 +- .../version-3.11/operator-guide/index.md | 2 +- .../aws/enable-irsa.md | 34 +----- .../aws/kaniko-irsa.md | 5 - .../monitoring-and-observability/loki-irsa.md | 4 - .../install-velero-add-ons.md | 114 ++++++++++++++++++ .../disaster-recovery/install-velero.md | 114 ------------------ .../disaster-recovery/velero-irsa.md | 95 --------------- .../velero-restore-platform.md | 2 +- .../version-3.12/operator-guide/index.md | 2 +- .../aws/enable-irsa.md | 34 +----- .../aws/kaniko-irsa.md | 5 - .../monitoring-and-observability/loki-irsa.md | 4 - versioned_sidebars/version-3.10-sidebars.json | 3 +- versioned_sidebars/version-3.11-sidebars.json | 3 +- versioned_sidebars/version-3.12-sidebars.json | 3 +- 40 files changed, 527 insertions(+), 1074 deletions(-) create mode 100644 docs/operator-guide/disaster-recovery/install-velero-add-ons.md delete mode 100644 docs/operator-guide/disaster-recovery/install-velero.md delete mode 100644 docs/operator-guide/disaster-recovery/velero-irsa.md create mode 100644 versioned_docs/version-3.10/operator-guide/disaster-recovery/install-velero-add-ons.md delete mode 100644 versioned_docs/version-3.10/operator-guide/disaster-recovery/install-velero.md delete mode 100644 versioned_docs/version-3.10/operator-guide/disaster-recovery/velero-irsa.md create mode 100644 versioned_docs/version-3.11/operator-guide/disaster-recovery/install-velero-add-ons.md delete mode 100644 versioned_docs/version-3.11/operator-guide/disaster-recovery/install-velero.md delete mode 100644 versioned_docs/version-3.11/operator-guide/disaster-recovery/velero-irsa.md create mode 100644 versioned_docs/version-3.12/operator-guide/disaster-recovery/install-velero-add-ons.md delete mode 100644 versioned_docs/version-3.12/operator-guide/disaster-recovery/install-velero.md delete mode 100644 versioned_docs/version-3.12/operator-guide/disaster-recovery/velero-irsa.md diff --git a/api/src/redirectMappings.ts b/api/src/redirectMappings.ts index 644992173..a10b6e144 100644 --- a/api/src/redirectMappings.ts +++ b/api/src/redirectMappings.ts @@ -70,7 +70,7 @@ export const redirectMaps: Record = { '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', @@ -116,7 +116,6 @@ export const redirectMaps: Record = { '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', diff --git a/cspell.config.yaml b/cspell.config.yaml index a3f0398bc..4ab31de47 100644 --- a/cspell.config.yaml +++ b/cspell.config.yaml @@ -182,6 +182,8 @@ words: - passwordfile - patchset - patchsetcreated + - persistentvolumeclaims + - persistentvolumes - petclinic - pgcrypto - pgdb diff --git a/docs/operator-guide/add-ons-overview.md b/docs/operator-guide/add-ons-overview.md index b4268da5d..09c9a935a 100644 --- a/docs/operator-guide/add-ons-overview.md +++ b/docs/operator-guide/add-ons-overview.md @@ -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| diff --git a/docs/operator-guide/disaster-recovery/install-velero-add-ons.md b/docs/operator-guide/disaster-recovery/install-velero-add-ons.md new file mode 100644 index 000000000..0fe46b963 --- /dev/null +++ b/docs/operator-guide/disaster-recovery/install-velero-add-ons.md @@ -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" +--- + + +# Automated Kubernetes Backup and Restore Workflows With Velero + + + + + +[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_\_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) diff --git a/docs/operator-guide/disaster-recovery/install-velero.md b/docs/operator-guide/disaster-recovery/install-velero.md deleted file mode 100644 index d8e22c4da..000000000 --- a/docs/operator-guide/disaster-recovery/install-velero.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -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" ---- - - -# Install Velero - - - - - -[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. - -## Installation - -To install Velero, follow the steps below: - -1. Create **velero** namespace: - - ```bash - kubectl create namespace velero - ``` - -2. Add a chart repository: - - ```bash - helm repo add vmware-tanzu https://vmware-tanzu.github.io/helm-charts - helm repo update - ``` - - :::note - [Velero AWS Plugin](https://github.com/vmware-tanzu/velero-plugin-for-aws) requires access to AWS resources. - To configure access, please refer to the [IRSA for Velero](velero-irsa.md) documentation. - ::: - -3. Install **Velero v.2.14.13**: - - ```bash - helm install velero vmware-tanzu/velero \ - --version 2.14.13 \ - --values values.yaml \ - --namespace velero - ``` - - Check out the _values.yaml_ file sample of the Velero customization: - -
- - View: values.yaml - - ```yaml - image: - repository: velero/velero - tag: v1.5.3 - securityContext: - fsGroup: 65534 - restic: - securityContext: - fsGroup: 65534 - serviceAccount: - server: - create: true - name: edp-velero - annotations: - eks.amazonaws.com/role-arn: "arn:aws:iam:::role/AWSIRSA‹CLUSTER_NAME›‹VELERO_NAMESPACE›Velero" - credentials: - useSecret: false - configuration: - provider: aws - backupStorageLocation: - name: default - bucket: velero- - config: - region: eu-central-1 - volumeSnapshotLocation: - name: default - config: - region: - initContainers: - - name: velero-plugin-for-aws - image: velero/velero-plugin-for-aws:v1.1.0 - volumeMounts: - - mountPath: /target - name: plugins - ``` - -
- -4. Install the client side (velero cli) according to the official [documentation](https://velero.io/docs/v1.5/basic-install/). - -## Configuration - -1. Create backup for all components in the namespace: - - ```bash - velero backup create --include-namespaces - ``` - -2. Create a daily backup of the namespace: - - ```bash - velero schedule create --schedule "0 10 * * MON-FRI" --include-namespaces --ttl 120h0m0s - ``` - -3. To restore from backup, use the following command: - - ```bash - velero restore create --from-backup - ``` diff --git a/docs/operator-guide/disaster-recovery/velero-irsa.md b/docs/operator-guide/disaster-recovery/velero-irsa.md deleted file mode 100644 index 0ceae7220..000000000 --- a/docs/operator-guide/disaster-recovery/velero-irsa.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: "IAM Roles for Velero Kubernetes Service Accounts" -description: "Guide on configuring IAM roles for Velero service accounts in AWS EKS, enabling Velero to access AWS resources for backup and recovery operations." -sidebar_label: "IAM Roles for Velero" ---- - - -# IAM Roles for Velero Kubernetes Service Accounts - - - - - -:::note - Make sure that IRSA is enabled and [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master) is deployed according to the [Associate IAM Roles With Service Accounts](../infrastructure-providers/aws/enable-irsa.md) documentation. -::: - -[Velero AWS plugin](https://github.com/vmware-tanzu/velero-plugin-for-aws) requires access to AWS resources. Follow the steps below to create a required role: - -1. Create AWS IAM Policy `AWSIRSAVelero_policy`: - - ```json - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": [ - "ec2:DescribeVolumes", - "ec2:DescribeSnapshots", - "ec2:CreateTags", - "ec2:CreateVolume", - "ec2:CreateSnapshot", - "ec2:DeleteSnapshot" - ], - "Resource": "*" - }, - { - "Effect": "Allow", - "Action": [ - "s3:GetObject", - "s3:DeleteObject", - "s3:PutObject", - "s3:AbortMultipartUpload", - "s3:ListMultipartUploadParts" - ], - "Resource": [ - "arn:aws:s3:::velero-*/*" - ] - }, - { - "Effect": "Allow", - "Action": [ - "s3:ListBucket" - ], - "Resource": [ - "arn:aws:s3:::velero-*" - ] - } - ] - } - ``` - -2. Create AWS IAM Role `AWSIRSAVelero` with trust relationships: - - ```json - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Federated": "arn:aws:iam:::oidc-provider/" - }, - "Action": "sts:AssumeRoleWithWebIdentity", - "Condition": { - "StringEquals": { - ":sub": "system:serviceaccount::edp-velero" - } - } - } - ] - } - ``` - -3. Attach the `AWSIRSAVelero_policy` policy to the `AWSIRSAVelero` role. - -4. Make sure that [Amazon S3](https://aws.amazon.com/s3/) bucket with name `velero-` exists. - -5. Provide key value **eks.amazonaws.com/role-arn: "arn:aws:iam::\:role/AWSIRSA‹CLUSTER_NAME›‹VELERO_NAMESPACE›Velero"** into the **serviceAccount.server.annotations** parameter in _values.yaml_ during the [Velero Installation](install-velero.md#installation). - -## Related Articles - -* [Associate IAM Roles With Service Accounts](../infrastructure-providers/aws/enable-irsa.md) -* [Install Velero](install-velero.md) diff --git a/docs/operator-guide/disaster-recovery/velero-restore-platform.md b/docs/operator-guide/disaster-recovery/velero-restore-platform.md index 40d58bd60..52ec1cc17 100644 --- a/docs/operator-guide/disaster-recovery/velero-restore-platform.md +++ b/docs/operator-guide/disaster-recovery/velero-restore-platform.md @@ -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-lock` names. Then restart all pods with operators, or simply run the following command: diff --git a/docs/operator-guide/index.md b/docs/operator-guide/index.md index 12d7301e3..850af84e3 100644 --- a/docs/operator-guide/index.md +++ b/docs/operator-guide/index.md @@ -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. diff --git a/docs/operator-guide/infrastructure-providers/aws/enable-irsa.md b/docs/operator-guide/infrastructure-providers/aws/enable-irsa.md index 854c5bef8..cf052a2fb 100644 --- a/docs/operator-guide/infrastructure-providers/aws/enable-irsa.md +++ b/docs/operator-guide/infrastructure-providers/aws/enable-irsa.md @@ -63,35 +63,7 @@ To successfully associate the IAM role with the service account, follow the step oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E ``` -2. Deploy the [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master) v0.2.0. - - :::note - The [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master) functionality is provided out of the box in EKS v1.21 and higher. This does not apply if the cluster has been upgraded from older versions. Therefore, skip step 2 and continue from step 3 in this documentation. - ::: - - 2.1. Provide the [stable](https://hub.docker.com/r/amazon/amazon-eks-pod-identity-webhook)(ed8c41f) version of the Docker image in the _deploy/deployment-base.yaml_ file. - - 2.2. Provide `${CA_BUNDLE}` in the _deploy/mutatingwebhook.yaml_ file: - - ```bash - secret_name=$(kubectl -n default get sa default -o jsonpath='{.secrets[0].name}') \ - CA_BUNDLE=$(kubectl -n default get secret/$secret_name -o jsonpath='{.data.ca\.crt}' | tr -d '\n') - ``` - - 2.3. Deploy the Webhook: - - ```bash - kubectl apply -f deploy/ - ``` - - 2.4. Approve the _csr_: - - ```bash - csr_name=$(kubectl get csr -o jsonpath='{.items[?(@.spec.username=="system:serviceaccount:default:pod-identity-webhook")].metadata.name}') - kubectl certificate approve $csr_name - ``` - -3. Annotate the created service account with the IAM role: +2. Annotate the created service account with the IAM role: **Service Account** @@ -105,7 +77,7 @@ To successfully associate the IAM role with the service account, follow the step eks.amazonaws.com/role-arn: "arn:aws:iam:::role/" ``` -4. All newly launched pods with this service account will be modified and then use the associated IAM role. Find below the pod specification template: +3. All newly launched pods with this service account will be modified and then use the associated IAM role. Find below the pod specification template: **Pod Template** @@ -123,7 +95,7 @@ To successfully associate the IAM role with the service account, follow the step command: ['sh', '-c', 'aws sts "get-caller-identity" && sleep 3600'] ``` -5. Check the logs of the created pod from the template above. +4. Check the logs of the created pod from the template above. Example output: diff --git a/docs/operator-guide/infrastructure-providers/aws/kaniko-irsa.md b/docs/operator-guide/infrastructure-providers/aws/kaniko-irsa.md index 55b7eff00..ecfe38eaf 100644 --- a/docs/operator-guide/infrastructure-providers/aws/kaniko-irsa.md +++ b/docs/operator-guide/infrastructure-providers/aws/kaniko-irsa.md @@ -13,11 +13,6 @@ sidebar_label: "IAM Roles for Kaniko Service Accounts" -:::note - The information below is relevant in case ECR is used as Docker container registry. - Make sure that IRSA is enabled and [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master) is deployed according to the [Associate IAM Roles With Service Accounts](enable-irsa.md) documentation. -::: - :::note Alternatively, the Kaniko IAM Role can also be created automatically during the cluster installation process. For more details, refer to the [Deploy AWS EKS Cluster](../../deploy-aws-eks.md) page. diff --git a/docs/operator-guide/monitoring-and-observability/loki-irsa.md b/docs/operator-guide/monitoring-and-observability/loki-irsa.md index 4f435f028..e62a28487 100644 --- a/docs/operator-guide/monitoring-and-observability/loki-irsa.md +++ b/docs/operator-guide/monitoring-and-observability/loki-irsa.md @@ -13,10 +13,6 @@ sidebar_label: "Loki IAM Roles" -:::note - Make sure that IRSA is enabled and [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master#amazon-eks-pod-identity-webhook) is deployed according to the [Associate IAM Roles With Service Accounts](../infrastructure-providers/aws/enable-irsa.md) documentation. -::: - It is possible to use Amazon Simple Storage Service [Amazon S3](https://aws.amazon.com/s3/) as object storage for Loki. In this case [Loki](https://grafana.com/docs/loki/latest/configure/examples/configuration-examples/) requires access to AWS resources. Follow the steps below to create a required role: diff --git a/package-lock.json b/package-lock.json index 2b8dfba48..55a4d553f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -243,6 +243,7 @@ "resolved": "https://registry.npmjs.org/@algolia/client-search/-/client-search-5.42.0.tgz", "integrity": "sha512-NZR7yyHj2WzK6D5X8gn+/KOxPdzYEXOqVdSaK/biU8QfYUpUuEA0sCWg/XlO05tPVEcJelF/oLrrNY3UjRbOww==", "license": "MIT", + "peer": true, "dependencies": { "@algolia/client-common": "5.42.0", "@algolia/requester-browser-xhr": "5.42.0", @@ -390,6 +391,7 @@ "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.28.5.tgz", "integrity": "sha512-e7jT4DxYvIDLk1ZHmU/m/mB19rex9sv0c2ftBtjSBv+kVM/902eh0fINUzD7UwLLNR+jU585GxUJ8/EBfAM5fw==", "license": "MIT", + "peer": true, "dependencies": { "@babel/code-frame": "^7.27.1", "@babel/generator": "^7.28.5", @@ -2224,6 +2226,7 @@ } ], "license": "MIT", + "peer": true, "engines": { "node": ">=18" }, @@ -2246,6 +2249,7 @@ } ], "license": "MIT", + "peer": true, "engines": { "node": ">=18" } @@ -2355,6 +2359,7 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.0.tgz", "integrity": "sha512-8sLjZwK0R+JlxlYcTuVnyT2v+htpdrjDOKuMcOVdYjt52Lh8hWRYpxBPoKx/Zg+bcjc3wx6fmQevMmUztS/ccA==", "license": "MIT", + "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -2776,6 +2781,7 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.0.tgz", "integrity": "sha512-8sLjZwK0R+JlxlYcTuVnyT2v+htpdrjDOKuMcOVdYjt52Lh8hWRYpxBPoKx/Zg+bcjc3wx6fmQevMmUztS/ccA==", "license": "MIT", + "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -3668,6 +3674,7 @@ "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.9.2.tgz", "integrity": "sha512-C5wZsGuKTY8jEYsqdxhhFOe1ZDjH0uIYJ9T/jebHwkyxqnr4wW0jTkB72OMqNjsoQRcb0JN3PcSeTwFlVgzCZg==", "license": "MIT", + "peer": true, "dependencies": { "@docusaurus/core": "3.9.2", "@docusaurus/logger": "3.9.2", @@ -4202,6 +4209,7 @@ "resolved": "https://registry.npmjs.org/@emotion/react/-/react-11.14.0.tgz", "integrity": "sha512-O000MLDBDdk/EohJPFUqvnp4qnHeYkVP5B0xEG0D/L7cOKP9kefu2DXn8dj74cQfsEzUqh+sr1RzFqiL1o+PpA==", "license": "MIT", + "peer": true, "dependencies": { "@babel/runtime": "^7.18.3", "@emotion/babel-plugin": "^11.13.5", @@ -4245,6 +4253,7 @@ "resolved": "https://registry.npmjs.org/@emotion/styled/-/styled-11.14.0.tgz", "integrity": "sha512-XxfOnXFffatap2IyCeJyNov3kiDQWoR08gPUQxvbL7fxKryGBKUZUkG6Hz48DZwVrJSVh9sJboyV1Ds4OW6SgA==", "license": "MIT", + "peer": true, "dependencies": { "@babel/runtime": "^7.18.3", "@emotion/babel-plugin": "^11.13.5", @@ -4325,7 +4334,6 @@ "integrity": "sha512-269Z39MS6wVJtsoUl10L60WdkhJVdPG24Q4eZTH3nnF6lpvSShEK3wQjDX9JRWAUPvPh7COouPpU9IrqaZFvtQ==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "ajv": "^6.12.4", "debug": "^4.3.2", @@ -4350,7 +4358,6 @@ "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -4362,7 +4369,6 @@ "integrity": "sha512-AhO5QUcj8llrbG09iWhPU2B204J1xnPeL8kQmVorSsy+Sjj1sk8gIyh6cUocGmH4L0UuhAJy+hJMRA4mgA4mFQ==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "type-fest": "^0.20.2" }, @@ -4379,7 +4385,6 @@ "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", "dev": true, "license": "ISC", - "peer": true, "dependencies": { "brace-expansion": "^1.1.7" }, @@ -4393,7 +4398,6 @@ "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", "dev": true, "license": "(MIT OR CC0-1.0)", - "peer": true, "engines": { "node": ">=10" }, @@ -4407,7 +4411,6 @@ "integrity": "sha512-d9zaMRSTIKDLhctzH12MtXvJKSSUhaHcjV+2Z+GK+EEY7XKpP5yR4x+N3TAcHTcu963nIr+TMcCb4DBCYX1z6Q==", "dev": true, "license": "MIT", - "peer": true, "engines": { "node": "^12.22.0 || ^14.17.0 || >=16.0.0" } @@ -4434,7 +4437,6 @@ "deprecated": "Use @eslint/config-array instead", "dev": true, "license": "Apache-2.0", - "peer": true, "dependencies": { "@humanwhocodes/object-schema": "^2.0.3", "debug": "^4.3.1", @@ -4450,7 +4452,6 @@ "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -4462,7 +4463,6 @@ "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", "dev": true, "license": "ISC", - "peer": true, "dependencies": { "brace-expansion": "^1.1.7" }, @@ -4476,7 +4476,6 @@ "integrity": "sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA==", "dev": true, "license": "Apache-2.0", - "peer": true, "engines": { "node": ">=12.22" }, @@ -4491,8 +4490,7 @@ "integrity": "sha512-93zYdMES/c1D69yZiKDBj0V24vqNzB/koF26KPaagAfd3P/4gUlh3Dys5ogAK+Exi9QyzlD8x/08Zt7wIKcDcA==", "deprecated": "Use @eslint/object-schema instead", "dev": true, - "license": "BSD-3-Clause", - "peer": true + "license": "BSD-3-Clause" }, "node_modules/@iconify/types": { "version": "2.0.0", @@ -4782,6 +4780,7 @@ "resolved": "https://registry.npmjs.org/@mdx-js/react/-/react-3.1.0.tgz", "integrity": "sha512-QjHtSaoameoalGnKDT3FoIl4+9RwyTmo9ZJGBdLOks/YOiWHoRDI3PUwEzOE7kEmGcV3AFcp9K6dYu9rEuKLAQ==", "license": "MIT", + "peer": true, "dependencies": { "@types/mdx": "^2.0.0" }, @@ -4844,6 +4843,7 @@ "resolved": "https://registry.npmjs.org/@mui/material/-/material-5.17.1.tgz", "integrity": "sha512-2B33kQf+GmPnrvXXweWAx+crbiUEsxCdCN979QDYnlH9ox4pd+0/IBriWLV+l6ORoBF60w39cWjFnJYGFdzXcw==", "license": "MIT", + "peer": true, "dependencies": { "@babel/runtime": "^7.23.9", "@mui/core-downloads-tracker": "^5.17.1", @@ -5356,6 +5356,7 @@ "resolved": "https://registry.npmjs.org/@svgr/core/-/core-8.1.0.tgz", "integrity": "sha512-8QqtOQT5ACVlmsvKOJNEaWmRPmcojMOzCz4Hs2BGG/toAp/K38LcsMRyLp349glq5AzJbCEeimEoxaX6v/fLrA==", "license": "MIT", + "peer": true, "dependencies": { "@babel/core": "^7.21.3", "@svgr/babel-preset": "8.1.0", @@ -5780,6 +5781,7 @@ "resolved": "https://registry.npmjs.org/@types/eslint/-/eslint-9.6.1.tgz", "integrity": "sha512-FXx2pKgId/WyYo2jXw63kk7/+TY7u7AziEJxJAnSFzHlqTAS3Ync6SvgYAN/k4/PQpnnVuzoMuVnByKK2qp0ag==", "license": "MIT", + "peer": true, "dependencies": { "@types/estree": "*", "@types/json-schema": "*" @@ -5998,6 +6000,7 @@ "resolved": "https://registry.npmjs.org/@types/react/-/react-19.1.8.tgz", "integrity": "sha512-AwAfQ2Wa5bCx9WP8nZL2uMZWod7J7/JSplxbTmBQ5ms6QpqNYm672H0Vu9ZVKVngQ+ii4R/byguVEUZQyeg44g==", "license": "MIT", + "peer": true, "dependencies": { "csstype": "^3.0.2" } @@ -6684,6 +6687,7 @@ "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.15.0.tgz", "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", "license": "MIT", + "peer": true, "bin": { "acorn": "bin/acorn" }, @@ -6757,6 +6761,7 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", "license": "MIT", + "peer": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -6821,6 +6826,7 @@ "resolved": "https://registry.npmjs.org/algoliasearch/-/algoliasearch-5.42.0.tgz", "integrity": "sha512-X5+PtWc9EJIPafT/cj8ZG+6IU3cjRRnlHGtqMHK/9gsiupQbAyYlH5y7qt/FtsAhfX5AICHffZy69ZAsVrxWkQ==", "license": "MIT", + "peer": true, "dependencies": { "@algolia/abtesting": "1.8.0", "@algolia/client-abtesting": "5.42.0", @@ -7363,6 +7369,7 @@ } ], "license": "MIT", + "peer": true, "dependencies": { "baseline-browser-mapping": "^2.8.19", "caniuse-lite": "^1.0.30001751", @@ -7662,6 +7669,7 @@ "resolved": "https://registry.npmjs.org/chevrotain/-/chevrotain-11.0.3.tgz", "integrity": "sha512-ci2iJH6LeIkvP9eJW6gpueU8cnZhv85ELY8w8WiFtNjMHA5ad6pQLaJo9mEly/9qUyCpvqX8/POVUTf18/HFdw==", "license": "Apache-2.0", + "peer": true, "dependencies": { "@chevrotain/cst-dts-gen": "11.0.3", "@chevrotain/gast": "11.0.3", @@ -8360,6 +8368,7 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.0.tgz", "integrity": "sha512-8sLjZwK0R+JlxlYcTuVnyT2v+htpdrjDOKuMcOVdYjt52Lh8hWRYpxBPoKx/Zg+bcjc3wx6fmQevMmUztS/ccA==", "license": "MIT", + "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -8679,6 +8688,7 @@ "resolved": "https://registry.npmjs.org/cytoscape/-/cytoscape-3.32.0.tgz", "integrity": "sha512-5JHBC9n75kz5851jeklCPmZWcg3hUe6sjqJvyk3+hVqFaKcHwHgxsjeN1yLmggoUc6STbtm9/NQyabQehfjvWQ==", "license": "MIT", + "peer": true, "engines": { "node": ">=0.10" } @@ -9088,6 +9098,7 @@ "resolved": "https://registry.npmjs.org/d3-selection/-/d3-selection-3.0.0.tgz", "integrity": "sha512-fmTRWbNMmsmWq6xJV8D19U/gw/bwrHfNXxrIN+HfZgnzqTHp9jOmKMhsTUjXOJnZOdZY9Q28y4yebKzqDKlxlQ==", "license": "ISC", + "peer": true, "engines": { "node": ">=12" } @@ -9265,8 +9276,7 @@ "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==", "dev": true, - "license": "MIT", - "peer": true + "license": "MIT" }, "node_modules/deepmerge": { "version": "4.3.1", @@ -9460,7 +9470,6 @@ "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==", "dev": true, "license": "Apache-2.0", - "peer": true, "dependencies": { "esutils": "^2.0.2" }, @@ -9925,7 +9934,6 @@ "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -9937,7 +9945,6 @@ "integrity": "sha512-dOt21O7lTMhDM+X9mB4GX+DZrZtCUJPL/wlcTqxyrx5IvO0IYtILdtrQGQp+8n5S0gwSVmOf9NQrjMOgfQZlIg==", "dev": true, "license": "BSD-2-Clause", - "peer": true, "dependencies": { "esrecurse": "^4.3.0", "estraverse": "^5.2.0" @@ -9955,7 +9962,6 @@ "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", "dev": true, "license": "BSD-2-Clause", - "peer": true, "engines": { "node": ">=4.0" } @@ -9966,7 +9972,6 @@ "integrity": "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==", "dev": true, "license": "ISC", - "peer": true, "dependencies": { "is-glob": "^4.0.3" }, @@ -9980,7 +9985,6 @@ "integrity": "sha512-AhO5QUcj8llrbG09iWhPU2B204J1xnPeL8kQmVorSsy+Sjj1sk8gIyh6cUocGmH4L0UuhAJy+hJMRA4mgA4mFQ==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "type-fest": "^0.20.2" }, @@ -9997,7 +10001,6 @@ "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", "dev": true, "license": "ISC", - "peer": true, "dependencies": { "brace-expansion": "^1.1.7" }, @@ -10011,7 +10014,6 @@ "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", "dev": true, "license": "(MIT OR CC0-1.0)", - "peer": true, "engines": { "node": ">=10" }, @@ -10025,7 +10027,6 @@ "integrity": "sha512-oruZaFkjorTpF32kDSI5/75ViwGeZginGGy2NoOSg3Q9bnwlnmDm4HLnkl0RE3n+njDXR037aY1+x58Z/zFdwQ==", "dev": true, "license": "BSD-2-Clause", - "peer": true, "dependencies": { "acorn": "^8.9.0", "acorn-jsx": "^5.3.2", @@ -10057,7 +10058,6 @@ "integrity": "sha512-ca9pw9fomFcKPvFLXhBKUK90ZvGibiGOvRJNbjljY7s7uq/5YO4BOzcYtJqExdx99rF6aAcnRxHmcUHcz6sQsg==", "dev": true, "license": "BSD-3-Clause", - "peer": true, "dependencies": { "estraverse": "^5.1.0" }, @@ -10071,7 +10071,6 @@ "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", "dev": true, "license": "BSD-2-Clause", - "peer": true, "engines": { "node": ">=4.0" } @@ -10459,8 +10458,7 @@ "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==", "dev": true, - "license": "MIT", - "peer": true + "license": "MIT" }, "node_modules/fast-uri": { "version": "3.0.6", @@ -10554,7 +10552,6 @@ "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "flat-cache": "^3.0.4" }, @@ -10673,7 +10670,6 @@ "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "locate-path": "^6.0.0", "path-exists": "^4.0.0" @@ -10700,7 +10696,6 @@ "integrity": "sha512-CYcENa+FtcUKLmhhqyctpclsq7QF38pKjZHsGNiSQF5r4FtoKDWabFDl3hzaEQMvT1LHEysw5twgLvpYYb4vbw==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "flatted": "^3.2.9", "keyv": "^4.5.3", @@ -10715,8 +10710,7 @@ "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.3.3.tgz", "integrity": "sha512-GX+ysw4PBCz0PzosHDepZGANEuFCMLrnRTiEy9McGjmkCQYwRq4A/X786G/fjM/+OjsWSU1ZrY5qyARZmO/uwg==", "dev": true, - "license": "ISC", - "peer": true + "license": "ISC" }, "node_modules/follow-redirects": { "version": "1.15.11", @@ -10805,8 +10799,7 @@ "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==", "dev": true, - "license": "ISC", - "peer": true + "license": "ISC" }, "node_modules/fsevents": { "version": "2.3.3", @@ -10920,7 +10913,6 @@ "deprecated": "Glob versions prior to v9 are no longer supported", "dev": true, "license": "ISC", - "peer": true, "dependencies": { "fs.realpath": "^1.0.0", "inflight": "^1.0.4", @@ -10976,7 +10968,6 @@ "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -10988,7 +10979,6 @@ "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", "dev": true, "license": "ISC", - "peer": true, "dependencies": { "brace-expansion": "^1.1.7" }, @@ -11830,7 +11820,6 @@ "deprecated": "This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.", "dev": true, "license": "ISC", - "peer": true, "dependencies": { "once": "^1.3.0", "wrappy": "1" @@ -12348,8 +12337,7 @@ "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", "integrity": "sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw==", "dev": true, - "license": "MIT", - "peer": true + "license": "MIT" }, "node_modules/json5": { "version": "2.2.3", @@ -12500,7 +12488,6 @@ "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "prelude-ls": "^1.2.1", "type-check": "~0.4.0" @@ -12573,7 +12560,6 @@ "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "p-locate": "^5.0.0" }, @@ -12613,8 +12599,7 @@ "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", "dev": true, - "license": "MIT", - "peer": true + "license": "MIT" }, "node_modules/lodash.uniq": { "version": "4.5.0", @@ -15451,7 +15436,6 @@ "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", "dev": true, "license": "ISC", - "peer": true, "dependencies": { "wrappy": "1" } @@ -15503,7 +15487,6 @@ "integrity": "sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "deep-is": "^0.1.3", "fast-levenshtein": "^2.0.6", @@ -15540,7 +15523,6 @@ "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "yocto-queue": "^0.1.0" }, @@ -15557,7 +15539,6 @@ "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "p-limit": "^3.0.2" }, @@ -15791,7 +15772,6 @@ "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", "dev": true, "license": "MIT", - "peer": true, "engines": { "node": ">=8" } @@ -15802,7 +15782,6 @@ "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", "dev": true, "license": "MIT", - "peer": true, "engines": { "node": ">=0.10.0" } @@ -16022,6 +16001,7 @@ } ], "license": "MIT", + "peer": true, "dependencies": { "nanoid": "^3.3.11", "picocolors": "^1.1.1", @@ -16925,6 +16905,7 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.0.tgz", "integrity": "sha512-8sLjZwK0R+JlxlYcTuVnyT2v+htpdrjDOKuMcOVdYjt52Lh8hWRYpxBPoKx/Zg+bcjc3wx6fmQevMmUztS/ccA==", "license": "MIT", + "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -17468,7 +17449,6 @@ "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", "dev": true, "license": "MIT", - "peer": true, "engines": { "node": ">= 0.8.0" } @@ -17794,6 +17774,7 @@ "resolved": "https://registry.npmjs.org/react/-/react-19.1.0.tgz", "integrity": "sha512-FS+XFBNvn3GTAWq26joslQgWNoFu08F4kl0J4CgdNKADkdSGXQyTCnKteIAJy96Br6YbpEU1LSzV5dYtjMkMDg==", "license": "MIT", + "peer": true, "engines": { "node": ">=0.10.0" } @@ -17803,6 +17784,7 @@ "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-19.1.0.tgz", "integrity": "sha512-Xs1hdnE+DyKgeHJeJznQmYMIBG3TKIHJJT95Q58nHLSrElKlGQqDTR2HQ9fx5CN/Gk6Vh/kupBTDLU11/nDk/g==", "license": "MIT", + "peer": true, "dependencies": { "scheduler": "^0.26.0" }, @@ -17858,6 +17840,7 @@ "resolved": "https://registry.npmjs.org/@docusaurus/react-loadable/-/react-loadable-6.0.0.tgz", "integrity": "sha512-YMMxTUQV/QFSnbgrP3tjDzLHRg7vsbMn8e9HAa8o/1iXoiomo48b7sk/kkmWEuWNDPJVlKSJRB6Y2fHqdJk+SQ==", "license": "MIT", + "peer": true, "dependencies": { "@types/react": "*" }, @@ -17903,6 +17886,7 @@ "resolved": "https://registry.npmjs.org/react-router/-/react-router-5.3.4.tgz", "integrity": "sha512-Ys9K+ppnJah3QuaRiLxk+jDWOR1MekYQrlytiXxC1RyfbdsZkS5pvKAzCCr031xHixZwpnsYNT5xysdFHQaYsA==", "license": "MIT", + "peer": true, "dependencies": { "@babel/runtime": "^7.12.13", "history": "^4.9.0", @@ -18531,7 +18515,6 @@ "deprecated": "Rimraf versions prior to v4 are no longer supported", "dev": true, "license": "ISC", - "peer": true, "dependencies": { "glob": "^7.1.3" }, @@ -18687,6 +18670,7 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", "license": "MIT", + "peer": true, "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", @@ -19708,8 +19692,7 @@ "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", "integrity": "sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw==", "dev": true, - "license": "MIT", - "peer": true + "license": "MIT" }, "node_modules/thingies": { "version": "2.5.0", @@ -19864,7 +19847,8 @@ "version": "2.8.1", "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", - "license": "0BSD" + "license": "0BSD", + "peer": true }, "node_modules/tsutils": { "version": "3.21.0", @@ -19895,7 +19879,6 @@ "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", "dev": true, "license": "MIT", - "peer": true, "dependencies": { "prelude-ls": "^1.2.1" }, @@ -19964,6 +19947,7 @@ "integrity": "sha512-hjcS1mhfuyi4WW8IWtjP7brDrG2cuDZukyrYrSauoXGNgx0S7zceP07adYkJycEr56BOUTNPzbInooiN3fn1qw==", "devOptional": true, "license": "Apache-2.0", + "peer": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -20540,6 +20524,7 @@ "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.99.9.tgz", "integrity": "sha512-brOPwM3JnmOa+7kd3NsmOUOwbDAj8FT9xDsG3IW0MgbN9yZV7Oi/s/+MNQ/EcSMqw7qfoRyXPoeEWT8zLVdVGg==", "license": "MIT", + "peer": true, "dependencies": { "@types/eslint-scope": "^3.7.7", "@types/estree": "^1.0.6", @@ -20965,7 +20950,6 @@ "integrity": "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA==", "dev": true, "license": "MIT", - "peer": true, "engines": { "node": ">=0.10.0" } @@ -21031,8 +21015,7 @@ "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", "dev": true, - "license": "ISC", - "peer": true + "license": "ISC" }, "node_modules/write-file-atomic": { "version": "3.0.3", @@ -21142,7 +21125,6 @@ "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", "dev": true, "license": "MIT", - "peer": true, "engines": { "node": ">=10" }, @@ -21155,6 +21137,7 @@ "resolved": "https://registry.npmjs.org/zod/-/zod-4.1.12.tgz", "integrity": "sha512-JInaHOamG8pt5+Ey8kGmdcAcg3OL9reK8ltczgHTAwNhMys/6ThXHityHxVV2p3fkw/c+MAvBHFVYHFZDmjMCQ==", "license": "MIT", + "peer": true, "funding": { "url": "https://github.com/sponsors/colinhacks" } diff --git a/sidebars.ts b/sidebars.ts index 5457639ea..14d9ce55e 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -339,8 +339,7 @@ const sidebars: SidebarsConfig = { type: 'category', label: 'Disaster Recovery', items: [ - 'operator-guide/disaster-recovery/install-velero', - 'operator-guide/disaster-recovery/velero-irsa', + 'operator-guide/disaster-recovery/install-velero-add-ons', 'operator-guide/disaster-recovery/velero-restore-platform', ], }, diff --git a/versioned_docs/version-3.10/operator-guide/disaster-recovery/install-velero-add-ons.md b/versioned_docs/version-3.10/operator-guide/disaster-recovery/install-velero-add-ons.md new file mode 100644 index 000000000..0fe46b963 --- /dev/null +++ b/versioned_docs/version-3.10/operator-guide/disaster-recovery/install-velero-add-ons.md @@ -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" +--- + + +# Automated Kubernetes Backup and Restore Workflows With Velero + + + + + +[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_\_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) diff --git a/versioned_docs/version-3.10/operator-guide/disaster-recovery/install-velero.md b/versioned_docs/version-3.10/operator-guide/disaster-recovery/install-velero.md deleted file mode 100644 index d8e22c4da..000000000 --- a/versioned_docs/version-3.10/operator-guide/disaster-recovery/install-velero.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -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" ---- - - -# Install Velero - - - - - -[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. - -## Installation - -To install Velero, follow the steps below: - -1. Create **velero** namespace: - - ```bash - kubectl create namespace velero - ``` - -2. Add a chart repository: - - ```bash - helm repo add vmware-tanzu https://vmware-tanzu.github.io/helm-charts - helm repo update - ``` - - :::note - [Velero AWS Plugin](https://github.com/vmware-tanzu/velero-plugin-for-aws) requires access to AWS resources. - To configure access, please refer to the [IRSA for Velero](velero-irsa.md) documentation. - ::: - -3. Install **Velero v.2.14.13**: - - ```bash - helm install velero vmware-tanzu/velero \ - --version 2.14.13 \ - --values values.yaml \ - --namespace velero - ``` - - Check out the _values.yaml_ file sample of the Velero customization: - -
- - View: values.yaml - - ```yaml - image: - repository: velero/velero - tag: v1.5.3 - securityContext: - fsGroup: 65534 - restic: - securityContext: - fsGroup: 65534 - serviceAccount: - server: - create: true - name: edp-velero - annotations: - eks.amazonaws.com/role-arn: "arn:aws:iam:::role/AWSIRSA‹CLUSTER_NAME›‹VELERO_NAMESPACE›Velero" - credentials: - useSecret: false - configuration: - provider: aws - backupStorageLocation: - name: default - bucket: velero- - config: - region: eu-central-1 - volumeSnapshotLocation: - name: default - config: - region: - initContainers: - - name: velero-plugin-for-aws - image: velero/velero-plugin-for-aws:v1.1.0 - volumeMounts: - - mountPath: /target - name: plugins - ``` - -
- -4. Install the client side (velero cli) according to the official [documentation](https://velero.io/docs/v1.5/basic-install/). - -## Configuration - -1. Create backup for all components in the namespace: - - ```bash - velero backup create --include-namespaces - ``` - -2. Create a daily backup of the namespace: - - ```bash - velero schedule create --schedule "0 10 * * MON-FRI" --include-namespaces --ttl 120h0m0s - ``` - -3. To restore from backup, use the following command: - - ```bash - velero restore create --from-backup - ``` diff --git a/versioned_docs/version-3.10/operator-guide/disaster-recovery/velero-irsa.md b/versioned_docs/version-3.10/operator-guide/disaster-recovery/velero-irsa.md deleted file mode 100644 index 0ceae7220..000000000 --- a/versioned_docs/version-3.10/operator-guide/disaster-recovery/velero-irsa.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: "IAM Roles for Velero Kubernetes Service Accounts" -description: "Guide on configuring IAM roles for Velero service accounts in AWS EKS, enabling Velero to access AWS resources for backup and recovery operations." -sidebar_label: "IAM Roles for Velero" ---- - - -# IAM Roles for Velero Kubernetes Service Accounts - - - - - -:::note - Make sure that IRSA is enabled and [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master) is deployed according to the [Associate IAM Roles With Service Accounts](../infrastructure-providers/aws/enable-irsa.md) documentation. -::: - -[Velero AWS plugin](https://github.com/vmware-tanzu/velero-plugin-for-aws) requires access to AWS resources. Follow the steps below to create a required role: - -1. Create AWS IAM Policy `AWSIRSAVelero_policy`: - - ```json - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": [ - "ec2:DescribeVolumes", - "ec2:DescribeSnapshots", - "ec2:CreateTags", - "ec2:CreateVolume", - "ec2:CreateSnapshot", - "ec2:DeleteSnapshot" - ], - "Resource": "*" - }, - { - "Effect": "Allow", - "Action": [ - "s3:GetObject", - "s3:DeleteObject", - "s3:PutObject", - "s3:AbortMultipartUpload", - "s3:ListMultipartUploadParts" - ], - "Resource": [ - "arn:aws:s3:::velero-*/*" - ] - }, - { - "Effect": "Allow", - "Action": [ - "s3:ListBucket" - ], - "Resource": [ - "arn:aws:s3:::velero-*" - ] - } - ] - } - ``` - -2. Create AWS IAM Role `AWSIRSAVelero` with trust relationships: - - ```json - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Federated": "arn:aws:iam:::oidc-provider/" - }, - "Action": "sts:AssumeRoleWithWebIdentity", - "Condition": { - "StringEquals": { - ":sub": "system:serviceaccount::edp-velero" - } - } - } - ] - } - ``` - -3. Attach the `AWSIRSAVelero_policy` policy to the `AWSIRSAVelero` role. - -4. Make sure that [Amazon S3](https://aws.amazon.com/s3/) bucket with name `velero-` exists. - -5. Provide key value **eks.amazonaws.com/role-arn: "arn:aws:iam::\:role/AWSIRSA‹CLUSTER_NAME›‹VELERO_NAMESPACE›Velero"** into the **serviceAccount.server.annotations** parameter in _values.yaml_ during the [Velero Installation](install-velero.md#installation). - -## Related Articles - -* [Associate IAM Roles With Service Accounts](../infrastructure-providers/aws/enable-irsa.md) -* [Install Velero](install-velero.md) diff --git a/versioned_docs/version-3.10/operator-guide/disaster-recovery/velero-restore-platform.md b/versioned_docs/version-3.10/operator-guide/disaster-recovery/velero-restore-platform.md index 40d58bd60..52ec1cc17 100644 --- a/versioned_docs/version-3.10/operator-guide/disaster-recovery/velero-restore-platform.md +++ b/versioned_docs/version-3.10/operator-guide/disaster-recovery/velero-restore-platform.md @@ -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-lock` names. Then restart all pods with operators, or simply run the following command: diff --git a/versioned_docs/version-3.10/operator-guide/index.md b/versioned_docs/version-3.10/operator-guide/index.md index d4b2c2596..ed1dd16e5 100644 --- a/versioned_docs/version-3.10/operator-guide/index.md +++ b/versioned_docs/version-3.10/operator-guide/index.md @@ -24,6 +24,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. diff --git a/versioned_docs/version-3.10/operator-guide/infrastructure-providers/aws/enable-irsa.md b/versioned_docs/version-3.10/operator-guide/infrastructure-providers/aws/enable-irsa.md index 854c5bef8..cf052a2fb 100644 --- a/versioned_docs/version-3.10/operator-guide/infrastructure-providers/aws/enable-irsa.md +++ b/versioned_docs/version-3.10/operator-guide/infrastructure-providers/aws/enable-irsa.md @@ -63,35 +63,7 @@ To successfully associate the IAM role with the service account, follow the step oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E ``` -2. Deploy the [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master) v0.2.0. - - :::note - The [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master) functionality is provided out of the box in EKS v1.21 and higher. This does not apply if the cluster has been upgraded from older versions. Therefore, skip step 2 and continue from step 3 in this documentation. - ::: - - 2.1. Provide the [stable](https://hub.docker.com/r/amazon/amazon-eks-pod-identity-webhook)(ed8c41f) version of the Docker image in the _deploy/deployment-base.yaml_ file. - - 2.2. Provide `${CA_BUNDLE}` in the _deploy/mutatingwebhook.yaml_ file: - - ```bash - secret_name=$(kubectl -n default get sa default -o jsonpath='{.secrets[0].name}') \ - CA_BUNDLE=$(kubectl -n default get secret/$secret_name -o jsonpath='{.data.ca\.crt}' | tr -d '\n') - ``` - - 2.3. Deploy the Webhook: - - ```bash - kubectl apply -f deploy/ - ``` - - 2.4. Approve the _csr_: - - ```bash - csr_name=$(kubectl get csr -o jsonpath='{.items[?(@.spec.username=="system:serviceaccount:default:pod-identity-webhook")].metadata.name}') - kubectl certificate approve $csr_name - ``` - -3. Annotate the created service account with the IAM role: +2. Annotate the created service account with the IAM role: **Service Account** @@ -105,7 +77,7 @@ To successfully associate the IAM role with the service account, follow the step eks.amazonaws.com/role-arn: "arn:aws:iam:::role/" ``` -4. All newly launched pods with this service account will be modified and then use the associated IAM role. Find below the pod specification template: +3. All newly launched pods with this service account will be modified and then use the associated IAM role. Find below the pod specification template: **Pod Template** @@ -123,7 +95,7 @@ To successfully associate the IAM role with the service account, follow the step command: ['sh', '-c', 'aws sts "get-caller-identity" && sleep 3600'] ``` -5. Check the logs of the created pod from the template above. +4. Check the logs of the created pod from the template above. Example output: diff --git a/versioned_docs/version-3.10/operator-guide/infrastructure-providers/aws/kaniko-irsa.md b/versioned_docs/version-3.10/operator-guide/infrastructure-providers/aws/kaniko-irsa.md index 55b7eff00..ecfe38eaf 100644 --- a/versioned_docs/version-3.10/operator-guide/infrastructure-providers/aws/kaniko-irsa.md +++ b/versioned_docs/version-3.10/operator-guide/infrastructure-providers/aws/kaniko-irsa.md @@ -13,11 +13,6 @@ sidebar_label: "IAM Roles for Kaniko Service Accounts" -:::note - The information below is relevant in case ECR is used as Docker container registry. - Make sure that IRSA is enabled and [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master) is deployed according to the [Associate IAM Roles With Service Accounts](enable-irsa.md) documentation. -::: - :::note Alternatively, the Kaniko IAM Role can also be created automatically during the cluster installation process. For more details, refer to the [Deploy AWS EKS Cluster](../../deploy-aws-eks.md) page. diff --git a/versioned_docs/version-3.10/operator-guide/monitoring-and-observability/loki-irsa.md b/versioned_docs/version-3.10/operator-guide/monitoring-and-observability/loki-irsa.md index 4f435f028..e62a28487 100644 --- a/versioned_docs/version-3.10/operator-guide/monitoring-and-observability/loki-irsa.md +++ b/versioned_docs/version-3.10/operator-guide/monitoring-and-observability/loki-irsa.md @@ -13,10 +13,6 @@ sidebar_label: "Loki IAM Roles" -:::note - Make sure that IRSA is enabled and [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master#amazon-eks-pod-identity-webhook) is deployed according to the [Associate IAM Roles With Service Accounts](../infrastructure-providers/aws/enable-irsa.md) documentation. -::: - It is possible to use Amazon Simple Storage Service [Amazon S3](https://aws.amazon.com/s3/) as object storage for Loki. In this case [Loki](https://grafana.com/docs/loki/latest/configure/examples/configuration-examples/) requires access to AWS resources. Follow the steps below to create a required role: diff --git a/versioned_docs/version-3.11/operator-guide/disaster-recovery/install-velero-add-ons.md b/versioned_docs/version-3.11/operator-guide/disaster-recovery/install-velero-add-ons.md new file mode 100644 index 000000000..0fe46b963 --- /dev/null +++ b/versioned_docs/version-3.11/operator-guide/disaster-recovery/install-velero-add-ons.md @@ -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" +--- + + +# Automated Kubernetes Backup and Restore Workflows With Velero + + + + + +[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_\_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) diff --git a/versioned_docs/version-3.11/operator-guide/disaster-recovery/install-velero.md b/versioned_docs/version-3.11/operator-guide/disaster-recovery/install-velero.md deleted file mode 100644 index d8e22c4da..000000000 --- a/versioned_docs/version-3.11/operator-guide/disaster-recovery/install-velero.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -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" ---- - - -# Install Velero - - - - - -[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. - -## Installation - -To install Velero, follow the steps below: - -1. Create **velero** namespace: - - ```bash - kubectl create namespace velero - ``` - -2. Add a chart repository: - - ```bash - helm repo add vmware-tanzu https://vmware-tanzu.github.io/helm-charts - helm repo update - ``` - - :::note - [Velero AWS Plugin](https://github.com/vmware-tanzu/velero-plugin-for-aws) requires access to AWS resources. - To configure access, please refer to the [IRSA for Velero](velero-irsa.md) documentation. - ::: - -3. Install **Velero v.2.14.13**: - - ```bash - helm install velero vmware-tanzu/velero \ - --version 2.14.13 \ - --values values.yaml \ - --namespace velero - ``` - - Check out the _values.yaml_ file sample of the Velero customization: - -
- - View: values.yaml - - ```yaml - image: - repository: velero/velero - tag: v1.5.3 - securityContext: - fsGroup: 65534 - restic: - securityContext: - fsGroup: 65534 - serviceAccount: - server: - create: true - name: edp-velero - annotations: - eks.amazonaws.com/role-arn: "arn:aws:iam:::role/AWSIRSA‹CLUSTER_NAME›‹VELERO_NAMESPACE›Velero" - credentials: - useSecret: false - configuration: - provider: aws - backupStorageLocation: - name: default - bucket: velero- - config: - region: eu-central-1 - volumeSnapshotLocation: - name: default - config: - region: - initContainers: - - name: velero-plugin-for-aws - image: velero/velero-plugin-for-aws:v1.1.0 - volumeMounts: - - mountPath: /target - name: plugins - ``` - -
- -4. Install the client side (velero cli) according to the official [documentation](https://velero.io/docs/v1.5/basic-install/). - -## Configuration - -1. Create backup for all components in the namespace: - - ```bash - velero backup create --include-namespaces - ``` - -2. Create a daily backup of the namespace: - - ```bash - velero schedule create --schedule "0 10 * * MON-FRI" --include-namespaces --ttl 120h0m0s - ``` - -3. To restore from backup, use the following command: - - ```bash - velero restore create --from-backup - ``` diff --git a/versioned_docs/version-3.11/operator-guide/disaster-recovery/velero-irsa.md b/versioned_docs/version-3.11/operator-guide/disaster-recovery/velero-irsa.md deleted file mode 100644 index 0ceae7220..000000000 --- a/versioned_docs/version-3.11/operator-guide/disaster-recovery/velero-irsa.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: "IAM Roles for Velero Kubernetes Service Accounts" -description: "Guide on configuring IAM roles for Velero service accounts in AWS EKS, enabling Velero to access AWS resources for backup and recovery operations." -sidebar_label: "IAM Roles for Velero" ---- - - -# IAM Roles for Velero Kubernetes Service Accounts - - - - - -:::note - Make sure that IRSA is enabled and [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master) is deployed according to the [Associate IAM Roles With Service Accounts](../infrastructure-providers/aws/enable-irsa.md) documentation. -::: - -[Velero AWS plugin](https://github.com/vmware-tanzu/velero-plugin-for-aws) requires access to AWS resources. Follow the steps below to create a required role: - -1. Create AWS IAM Policy `AWSIRSAVelero_policy`: - - ```json - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": [ - "ec2:DescribeVolumes", - "ec2:DescribeSnapshots", - "ec2:CreateTags", - "ec2:CreateVolume", - "ec2:CreateSnapshot", - "ec2:DeleteSnapshot" - ], - "Resource": "*" - }, - { - "Effect": "Allow", - "Action": [ - "s3:GetObject", - "s3:DeleteObject", - "s3:PutObject", - "s3:AbortMultipartUpload", - "s3:ListMultipartUploadParts" - ], - "Resource": [ - "arn:aws:s3:::velero-*/*" - ] - }, - { - "Effect": "Allow", - "Action": [ - "s3:ListBucket" - ], - "Resource": [ - "arn:aws:s3:::velero-*" - ] - } - ] - } - ``` - -2. Create AWS IAM Role `AWSIRSAVelero` with trust relationships: - - ```json - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Federated": "arn:aws:iam:::oidc-provider/" - }, - "Action": "sts:AssumeRoleWithWebIdentity", - "Condition": { - "StringEquals": { - ":sub": "system:serviceaccount::edp-velero" - } - } - } - ] - } - ``` - -3. Attach the `AWSIRSAVelero_policy` policy to the `AWSIRSAVelero` role. - -4. Make sure that [Amazon S3](https://aws.amazon.com/s3/) bucket with name `velero-` exists. - -5. Provide key value **eks.amazonaws.com/role-arn: "arn:aws:iam::\:role/AWSIRSA‹CLUSTER_NAME›‹VELERO_NAMESPACE›Velero"** into the **serviceAccount.server.annotations** parameter in _values.yaml_ during the [Velero Installation](install-velero.md#installation). - -## Related Articles - -* [Associate IAM Roles With Service Accounts](../infrastructure-providers/aws/enable-irsa.md) -* [Install Velero](install-velero.md) diff --git a/versioned_docs/version-3.11/operator-guide/disaster-recovery/velero-restore-platform.md b/versioned_docs/version-3.11/operator-guide/disaster-recovery/velero-restore-platform.md index 40d58bd60..52ec1cc17 100644 --- a/versioned_docs/version-3.11/operator-guide/disaster-recovery/velero-restore-platform.md +++ b/versioned_docs/version-3.11/operator-guide/disaster-recovery/velero-restore-platform.md @@ -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-lock` names. Then restart all pods with operators, or simply run the following command: diff --git a/versioned_docs/version-3.11/operator-guide/index.md b/versioned_docs/version-3.11/operator-guide/index.md index d4b2c2596..ed1dd16e5 100644 --- a/versioned_docs/version-3.11/operator-guide/index.md +++ b/versioned_docs/version-3.11/operator-guide/index.md @@ -24,6 +24,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. diff --git a/versioned_docs/version-3.11/operator-guide/infrastructure-providers/aws/enable-irsa.md b/versioned_docs/version-3.11/operator-guide/infrastructure-providers/aws/enable-irsa.md index 854c5bef8..cf052a2fb 100644 --- a/versioned_docs/version-3.11/operator-guide/infrastructure-providers/aws/enable-irsa.md +++ b/versioned_docs/version-3.11/operator-guide/infrastructure-providers/aws/enable-irsa.md @@ -63,35 +63,7 @@ To successfully associate the IAM role with the service account, follow the step oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E ``` -2. Deploy the [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master) v0.2.0. - - :::note - The [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master) functionality is provided out of the box in EKS v1.21 and higher. This does not apply if the cluster has been upgraded from older versions. Therefore, skip step 2 and continue from step 3 in this documentation. - ::: - - 2.1. Provide the [stable](https://hub.docker.com/r/amazon/amazon-eks-pod-identity-webhook)(ed8c41f) version of the Docker image in the _deploy/deployment-base.yaml_ file. - - 2.2. Provide `${CA_BUNDLE}` in the _deploy/mutatingwebhook.yaml_ file: - - ```bash - secret_name=$(kubectl -n default get sa default -o jsonpath='{.secrets[0].name}') \ - CA_BUNDLE=$(kubectl -n default get secret/$secret_name -o jsonpath='{.data.ca\.crt}' | tr -d '\n') - ``` - - 2.3. Deploy the Webhook: - - ```bash - kubectl apply -f deploy/ - ``` - - 2.4. Approve the _csr_: - - ```bash - csr_name=$(kubectl get csr -o jsonpath='{.items[?(@.spec.username=="system:serviceaccount:default:pod-identity-webhook")].metadata.name}') - kubectl certificate approve $csr_name - ``` - -3. Annotate the created service account with the IAM role: +2. Annotate the created service account with the IAM role: **Service Account** @@ -105,7 +77,7 @@ To successfully associate the IAM role with the service account, follow the step eks.amazonaws.com/role-arn: "arn:aws:iam:::role/" ``` -4. All newly launched pods with this service account will be modified and then use the associated IAM role. Find below the pod specification template: +3. All newly launched pods with this service account will be modified and then use the associated IAM role. Find below the pod specification template: **Pod Template** @@ -123,7 +95,7 @@ To successfully associate the IAM role with the service account, follow the step command: ['sh', '-c', 'aws sts "get-caller-identity" && sleep 3600'] ``` -5. Check the logs of the created pod from the template above. +4. Check the logs of the created pod from the template above. Example output: diff --git a/versioned_docs/version-3.11/operator-guide/infrastructure-providers/aws/kaniko-irsa.md b/versioned_docs/version-3.11/operator-guide/infrastructure-providers/aws/kaniko-irsa.md index 55b7eff00..ecfe38eaf 100644 --- a/versioned_docs/version-3.11/operator-guide/infrastructure-providers/aws/kaniko-irsa.md +++ b/versioned_docs/version-3.11/operator-guide/infrastructure-providers/aws/kaniko-irsa.md @@ -13,11 +13,6 @@ sidebar_label: "IAM Roles for Kaniko Service Accounts" -:::note - The information below is relevant in case ECR is used as Docker container registry. - Make sure that IRSA is enabled and [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master) is deployed according to the [Associate IAM Roles With Service Accounts](enable-irsa.md) documentation. -::: - :::note Alternatively, the Kaniko IAM Role can also be created automatically during the cluster installation process. For more details, refer to the [Deploy AWS EKS Cluster](../../deploy-aws-eks.md) page. diff --git a/versioned_docs/version-3.11/operator-guide/monitoring-and-observability/loki-irsa.md b/versioned_docs/version-3.11/operator-guide/monitoring-and-observability/loki-irsa.md index 4f435f028..e62a28487 100644 --- a/versioned_docs/version-3.11/operator-guide/monitoring-and-observability/loki-irsa.md +++ b/versioned_docs/version-3.11/operator-guide/monitoring-and-observability/loki-irsa.md @@ -13,10 +13,6 @@ sidebar_label: "Loki IAM Roles" -:::note - Make sure that IRSA is enabled and [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master#amazon-eks-pod-identity-webhook) is deployed according to the [Associate IAM Roles With Service Accounts](../infrastructure-providers/aws/enable-irsa.md) documentation. -::: - It is possible to use Amazon Simple Storage Service [Amazon S3](https://aws.amazon.com/s3/) as object storage for Loki. In this case [Loki](https://grafana.com/docs/loki/latest/configure/examples/configuration-examples/) requires access to AWS resources. Follow the steps below to create a required role: diff --git a/versioned_docs/version-3.12/operator-guide/disaster-recovery/install-velero-add-ons.md b/versioned_docs/version-3.12/operator-guide/disaster-recovery/install-velero-add-ons.md new file mode 100644 index 000000000..0fe46b963 --- /dev/null +++ b/versioned_docs/version-3.12/operator-guide/disaster-recovery/install-velero-add-ons.md @@ -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" +--- + + +# Automated Kubernetes Backup and Restore Workflows With Velero + + + + + +[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_\_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) diff --git a/versioned_docs/version-3.12/operator-guide/disaster-recovery/install-velero.md b/versioned_docs/version-3.12/operator-guide/disaster-recovery/install-velero.md deleted file mode 100644 index d8e22c4da..000000000 --- a/versioned_docs/version-3.12/operator-guide/disaster-recovery/install-velero.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -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" ---- - - -# Install Velero - - - - - -[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. - -## Installation - -To install Velero, follow the steps below: - -1. Create **velero** namespace: - - ```bash - kubectl create namespace velero - ``` - -2. Add a chart repository: - - ```bash - helm repo add vmware-tanzu https://vmware-tanzu.github.io/helm-charts - helm repo update - ``` - - :::note - [Velero AWS Plugin](https://github.com/vmware-tanzu/velero-plugin-for-aws) requires access to AWS resources. - To configure access, please refer to the [IRSA for Velero](velero-irsa.md) documentation. - ::: - -3. Install **Velero v.2.14.13**: - - ```bash - helm install velero vmware-tanzu/velero \ - --version 2.14.13 \ - --values values.yaml \ - --namespace velero - ``` - - Check out the _values.yaml_ file sample of the Velero customization: - -
- - View: values.yaml - - ```yaml - image: - repository: velero/velero - tag: v1.5.3 - securityContext: - fsGroup: 65534 - restic: - securityContext: - fsGroup: 65534 - serviceAccount: - server: - create: true - name: edp-velero - annotations: - eks.amazonaws.com/role-arn: "arn:aws:iam:::role/AWSIRSA‹CLUSTER_NAME›‹VELERO_NAMESPACE›Velero" - credentials: - useSecret: false - configuration: - provider: aws - backupStorageLocation: - name: default - bucket: velero- - config: - region: eu-central-1 - volumeSnapshotLocation: - name: default - config: - region: - initContainers: - - name: velero-plugin-for-aws - image: velero/velero-plugin-for-aws:v1.1.0 - volumeMounts: - - mountPath: /target - name: plugins - ``` - -
- -4. Install the client side (velero cli) according to the official [documentation](https://velero.io/docs/v1.5/basic-install/). - -## Configuration - -1. Create backup for all components in the namespace: - - ```bash - velero backup create --include-namespaces - ``` - -2. Create a daily backup of the namespace: - - ```bash - velero schedule create --schedule "0 10 * * MON-FRI" --include-namespaces --ttl 120h0m0s - ``` - -3. To restore from backup, use the following command: - - ```bash - velero restore create --from-backup - ``` diff --git a/versioned_docs/version-3.12/operator-guide/disaster-recovery/velero-irsa.md b/versioned_docs/version-3.12/operator-guide/disaster-recovery/velero-irsa.md deleted file mode 100644 index 0ceae7220..000000000 --- a/versioned_docs/version-3.12/operator-guide/disaster-recovery/velero-irsa.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: "IAM Roles for Velero Kubernetes Service Accounts" -description: "Guide on configuring IAM roles for Velero service accounts in AWS EKS, enabling Velero to access AWS resources for backup and recovery operations." -sidebar_label: "IAM Roles for Velero" ---- - - -# IAM Roles for Velero Kubernetes Service Accounts - - - - - -:::note - Make sure that IRSA is enabled and [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master) is deployed according to the [Associate IAM Roles With Service Accounts](../infrastructure-providers/aws/enable-irsa.md) documentation. -::: - -[Velero AWS plugin](https://github.com/vmware-tanzu/velero-plugin-for-aws) requires access to AWS resources. Follow the steps below to create a required role: - -1. Create AWS IAM Policy `AWSIRSAVelero_policy`: - - ```json - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Action": [ - "ec2:DescribeVolumes", - "ec2:DescribeSnapshots", - "ec2:CreateTags", - "ec2:CreateVolume", - "ec2:CreateSnapshot", - "ec2:DeleteSnapshot" - ], - "Resource": "*" - }, - { - "Effect": "Allow", - "Action": [ - "s3:GetObject", - "s3:DeleteObject", - "s3:PutObject", - "s3:AbortMultipartUpload", - "s3:ListMultipartUploadParts" - ], - "Resource": [ - "arn:aws:s3:::velero-*/*" - ] - }, - { - "Effect": "Allow", - "Action": [ - "s3:ListBucket" - ], - "Resource": [ - "arn:aws:s3:::velero-*" - ] - } - ] - } - ``` - -2. Create AWS IAM Role `AWSIRSAVelero` with trust relationships: - - ```json - { - "Version": "2012-10-17", - "Statement": [ - { - "Effect": "Allow", - "Principal": { - "Federated": "arn:aws:iam:::oidc-provider/" - }, - "Action": "sts:AssumeRoleWithWebIdentity", - "Condition": { - "StringEquals": { - ":sub": "system:serviceaccount::edp-velero" - } - } - } - ] - } - ``` - -3. Attach the `AWSIRSAVelero_policy` policy to the `AWSIRSAVelero` role. - -4. Make sure that [Amazon S3](https://aws.amazon.com/s3/) bucket with name `velero-` exists. - -5. Provide key value **eks.amazonaws.com/role-arn: "arn:aws:iam::\:role/AWSIRSA‹CLUSTER_NAME›‹VELERO_NAMESPACE›Velero"** into the **serviceAccount.server.annotations** parameter in _values.yaml_ during the [Velero Installation](install-velero.md#installation). - -## Related Articles - -* [Associate IAM Roles With Service Accounts](../infrastructure-providers/aws/enable-irsa.md) -* [Install Velero](install-velero.md) diff --git a/versioned_docs/version-3.12/operator-guide/disaster-recovery/velero-restore-platform.md b/versioned_docs/version-3.12/operator-guide/disaster-recovery/velero-restore-platform.md index 40d58bd60..52ec1cc17 100644 --- a/versioned_docs/version-3.12/operator-guide/disaster-recovery/velero-restore-platform.md +++ b/versioned_docs/version-3.12/operator-guide/disaster-recovery/velero-restore-platform.md @@ -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-lock` names. Then restart all pods with operators, or simply run the following command: diff --git a/versioned_docs/version-3.12/operator-guide/index.md b/versioned_docs/version-3.12/operator-guide/index.md index 12d7301e3..850af84e3 100644 --- a/versioned_docs/version-3.12/operator-guide/index.md +++ b/versioned_docs/version-3.12/operator-guide/index.md @@ -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. diff --git a/versioned_docs/version-3.12/operator-guide/infrastructure-providers/aws/enable-irsa.md b/versioned_docs/version-3.12/operator-guide/infrastructure-providers/aws/enable-irsa.md index 854c5bef8..cf052a2fb 100644 --- a/versioned_docs/version-3.12/operator-guide/infrastructure-providers/aws/enable-irsa.md +++ b/versioned_docs/version-3.12/operator-guide/infrastructure-providers/aws/enable-irsa.md @@ -63,35 +63,7 @@ To successfully associate the IAM role with the service account, follow the step oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E ``` -2. Deploy the [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master) v0.2.0. - - :::note - The [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master) functionality is provided out of the box in EKS v1.21 and higher. This does not apply if the cluster has been upgraded from older versions. Therefore, skip step 2 and continue from step 3 in this documentation. - ::: - - 2.1. Provide the [stable](https://hub.docker.com/r/amazon/amazon-eks-pod-identity-webhook)(ed8c41f) version of the Docker image in the _deploy/deployment-base.yaml_ file. - - 2.2. Provide `${CA_BUNDLE}` in the _deploy/mutatingwebhook.yaml_ file: - - ```bash - secret_name=$(kubectl -n default get sa default -o jsonpath='{.secrets[0].name}') \ - CA_BUNDLE=$(kubectl -n default get secret/$secret_name -o jsonpath='{.data.ca\.crt}' | tr -d '\n') - ``` - - 2.3. Deploy the Webhook: - - ```bash - kubectl apply -f deploy/ - ``` - - 2.4. Approve the _csr_: - - ```bash - csr_name=$(kubectl get csr -o jsonpath='{.items[?(@.spec.username=="system:serviceaccount:default:pod-identity-webhook")].metadata.name}') - kubectl certificate approve $csr_name - ``` - -3. Annotate the created service account with the IAM role: +2. Annotate the created service account with the IAM role: **Service Account** @@ -105,7 +77,7 @@ To successfully associate the IAM role with the service account, follow the step eks.amazonaws.com/role-arn: "arn:aws:iam:::role/" ``` -4. All newly launched pods with this service account will be modified and then use the associated IAM role. Find below the pod specification template: +3. All newly launched pods with this service account will be modified and then use the associated IAM role. Find below the pod specification template: **Pod Template** @@ -123,7 +95,7 @@ To successfully associate the IAM role with the service account, follow the step command: ['sh', '-c', 'aws sts "get-caller-identity" && sleep 3600'] ``` -5. Check the logs of the created pod from the template above. +4. Check the logs of the created pod from the template above. Example output: diff --git a/versioned_docs/version-3.12/operator-guide/infrastructure-providers/aws/kaniko-irsa.md b/versioned_docs/version-3.12/operator-guide/infrastructure-providers/aws/kaniko-irsa.md index 55b7eff00..ecfe38eaf 100644 --- a/versioned_docs/version-3.12/operator-guide/infrastructure-providers/aws/kaniko-irsa.md +++ b/versioned_docs/version-3.12/operator-guide/infrastructure-providers/aws/kaniko-irsa.md @@ -13,11 +13,6 @@ sidebar_label: "IAM Roles for Kaniko Service Accounts" -:::note - The information below is relevant in case ECR is used as Docker container registry. - Make sure that IRSA is enabled and [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master) is deployed according to the [Associate IAM Roles With Service Accounts](enable-irsa.md) documentation. -::: - :::note Alternatively, the Kaniko IAM Role can also be created automatically during the cluster installation process. For more details, refer to the [Deploy AWS EKS Cluster](../../deploy-aws-eks.md) page. diff --git a/versioned_docs/version-3.12/operator-guide/monitoring-and-observability/loki-irsa.md b/versioned_docs/version-3.12/operator-guide/monitoring-and-observability/loki-irsa.md index 4f435f028..e62a28487 100644 --- a/versioned_docs/version-3.12/operator-guide/monitoring-and-observability/loki-irsa.md +++ b/versioned_docs/version-3.12/operator-guide/monitoring-and-observability/loki-irsa.md @@ -13,10 +13,6 @@ sidebar_label: "Loki IAM Roles" -:::note - Make sure that IRSA is enabled and [amazon-eks-pod-identity-webhook](https://github.com/aws/amazon-eks-pod-identity-webhook/tree/master#amazon-eks-pod-identity-webhook) is deployed according to the [Associate IAM Roles With Service Accounts](../infrastructure-providers/aws/enable-irsa.md) documentation. -::: - It is possible to use Amazon Simple Storage Service [Amazon S3](https://aws.amazon.com/s3/) as object storage for Loki. In this case [Loki](https://grafana.com/docs/loki/latest/configure/examples/configuration-examples/) requires access to AWS resources. Follow the steps below to create a required role: diff --git a/versioned_sidebars/version-3.10-sidebars.json b/versioned_sidebars/version-3.10-sidebars.json index 0e3b84e09..eb57ab3d7 100644 --- a/versioned_sidebars/version-3.10-sidebars.json +++ b/versioned_sidebars/version-3.10-sidebars.json @@ -311,8 +311,7 @@ "type": "category", "label": "Disaster Recovery", "items": [ - "operator-guide/disaster-recovery/install-velero", - "operator-guide/disaster-recovery/velero-irsa", + "operator-guide/disaster-recovery/install-velero-add-ons", "operator-guide/disaster-recovery/velero-restore-platform" ] }, diff --git a/versioned_sidebars/version-3.11-sidebars.json b/versioned_sidebars/version-3.11-sidebars.json index 7eb0b628f..f2ef227f7 100644 --- a/versioned_sidebars/version-3.11-sidebars.json +++ b/versioned_sidebars/version-3.11-sidebars.json @@ -312,8 +312,7 @@ "type": "category", "label": "Disaster Recovery", "items": [ - "operator-guide/disaster-recovery/install-velero", - "operator-guide/disaster-recovery/velero-irsa", + "operator-guide/disaster-recovery/install-velero-add-ons", "operator-guide/disaster-recovery/velero-restore-platform" ] }, diff --git a/versioned_sidebars/version-3.12-sidebars.json b/versioned_sidebars/version-3.12-sidebars.json index 5be6c4006..5726789ed 100644 --- a/versioned_sidebars/version-3.12-sidebars.json +++ b/versioned_sidebars/version-3.12-sidebars.json @@ -314,8 +314,7 @@ "type": "category", "label": "Disaster Recovery", "items": [ - "operator-guide/disaster-recovery/install-velero", - "operator-guide/disaster-recovery/velero-irsa", + "operator-guide/disaster-recovery/install-velero-add-ons", "operator-guide/disaster-recovery/velero-restore-platform" ] },