Skip to content

Commit

Permalink
Merge pull request #4884 from EnterpriseDB/release/2023-10-05
Browse files Browse the repository at this point in the history
Production Release: 2023-10-05
  • Loading branch information
ccestes authored Oct 5, 2023
2 parents 2aafadf + 4c7ebe5 commit 7e3790f
Show file tree
Hide file tree
Showing 14 changed files with 235 additions and 131 deletions.
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: 'Partner Information'
description: 'Details of the Partner'
title: 'Partner information'
description: 'Details of the partner'

---
|   |   |
| ----------- | ----------- |
| **Partner Name** | Kasten by Veeam |
| **Web Site** | https://www.kasten.io/ |
| **Partner Product** | Kasten K10 |
| **Partner name** | Kasten by Veeam |
| **Website** | https://www.kasten.io/ |
| **Partner product** | Kasten K10 |
| **Version** | Kasten 6.0 |
| **Product Description** | Kasten K10 is a Cloud Native data management platform for Day 2 operations. Purpose built for Kubernetes, Kasten backups and restores your applications, handles disaster recovery and manages application migration. Kasten can be implemented with EDB Postgres for Kubernetes to create fast backups and restores. |
| **Product description** | Kasten K10 is a cloud-native data management platform for Day 2 operations. Built for Kubernetes, Kasten backs up and restores your applications, handles disaster recovery, and manages application migration. Kasten can be implemented with EDB Postgres for Kubernetes to create fast backups and restores. |
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: 'Solution Summary'
title: 'Solution summary'
description: 'Explanation of the solution and its purpose'
---

Kasten by Veeam is a data management platform built for Kubernetes that can provide enterprise operations teams with an easy-to-use and secure system for backup and restore of Kubernetes applications. Kasten can be used in conjunction with EDB Postgres for Kubernetes and the EDB external backup adapter to successfully backup and restore data.
Kasten by Veeam is a data management platform built for Kubernetes that can provide enterprise operations teams with an easy-to-use and secure system for backup and restore of Kubernetes applications. Kasten can be used with EDB Postgres for Kubernetes and the EDB external backup adapter to successfully back up and restore data.

The EDB Postgres for Kubernetes [external backup adapter](https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/addons/#external-backup-adapter) allows for a third party tool, such as Kasten by Veeam, to discover an API that is needed in order to create a successful backup.
The EDB Postgres for Kubernetes [external backup adapter](https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/addons/#external-backup-adapter) allows for a third-party tool, such as Kasten by Veeam, to discover an API that's needed to create a successful backup.

![Kasten K10 Architecture](Images/KastenSolutionSummaryImagenew.png)
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Configuration'
description: 'Walkthrough on configuring the integration'
description: 'Walkthrough of configuring the integration'
---

Implementing EDB Postgres for Kubernetes with Kasten by Veeam requires the following components:
Expand All @@ -16,32 +16,32 @@ Implementing EDB Postgres for Kubernetes with Kasten by Veeam requires the follo
- Kasten K10 installed on your system

!!! Note
For this integration, use the **example.yaml** files provided in each section for the appropriate Kasten configuration pieces, and change any environment variables per your specific needs.
For this integration, use the `example.yaml` files provided for the appropriate Kasten configuration pieces, and change any environment variables per your specific needs.

The **Add the Backup Decorator Annotations to the Cluster** section is the important section for the Kasten addon integration.
See [Add the backup decorator annotations to the cluster](#add-the-backup-decorator-annotations-to-the-cluster), which is important for the Kasten add-on integration.

Refer to the [EDB Postgres for Kubernetes external backup adapter](https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/addons/#external-backup-adapter) docs to view more detailed information on the EDB Postgres for Kubernetes backup adaptor addon functionality and additional details on its configuraton parameters.
Refer to the [EDB Postgres for Kubernetes external backup adapter](/postgres_for_kubernetes/latest/addons/#external-backup-adapter) documentation for more detailed information on the EDB Postgres for Kubernetes backup adaptor add-on functionality and additional details on its configuraton parameters.

## Install the Operator
## Install the operator

1. Install the EDB Postgres for Kubernetes operator.
Install the EDB Postgres for Kubernetes operator.

```bash
kubectl apply -f https://get.enterprisedb.io/cnp/postgresql-operator-1.20.2.yaml
```

Running this command will create the operator namespace where the controller will be running.
Running this command creates the operator namespace where the controller runs.

## Create an EDB Cluster, Client and Add Data
## Create an EDB cluster and client and add data

1. Initiate the below lines of code in your Kubernetes environment to create a specific namespace and apply your `.yaml` file.
1. In your Kubernetes environment, create a specific namespace and apply your `.yaml` file:

```bash
kubctl create ns edb
kubectl apply -f cluster-example.yaml -n edb
```

### Example **cluster-example.yaml** file:
Example `cluster-example.yaml` file:

```bash
# Example of PostgreSQL cluster
Expand Down Expand Up @@ -94,7 +94,9 @@ kubectl cnp certificate cluster-app \
```bash
kubectl create -f client.yaml -n edb
```
### Example **client.yaml** file:

Example `client.yaml` file:

```bash
apiVersion: apps/v1
kind: Deployment
Expand Down Expand Up @@ -148,7 +150,7 @@ spec:
defaultMode: 0600
```

6. Add some data into the cluster to test the backup and restore, the following is sample data that was used for this example.
6. Add some data into the cluster to test the backup and restore. The following is sample data that was used for this example:

```bash
kubectl exec -it deploy/cert-test -- bash
Expand All @@ -168,25 +170,25 @@ select * from links;
exit
```
## Add the Backup Decorator Annotations to the Cluster
## Add the backup decorator annotations to the cluster
If you create the cluster from the previous section the **cluster-example.yaml** already includes the Kasten addon therefore you can skip this part. If you are working with your own cluster you will need to add the Kasten addon.
If you created the cluster from the previous process, `cluster-example.yaml` already includes the Kasten add-on, and you can skip this part. If you're working with your own cluster, you need to add the Kasten add-on.
1. Add the following annotations to your cluster, in the above **cluster-example.yaml** there is an example of where to add the annotation.
1. Add the following annotations to your cluster. The previous `cluster-example.yaml` file shows an example of where to add the annotation.
```bash
"k8s.enterprisedb.io/addons": '["kasten"]'
```
## Install the EDB blueprint
1. Enter the following command in your environment:
1. In your environment, enter:
```bash
kubectl create -f edb-hooks.yaml
```
### Example **edb-hooks.yaml** file:
Example `edb-hooks.yaml` file:
```bash
apiVersion: cr.kanister.io/v1alpha1
Expand Down Expand Up @@ -260,14 +262,12 @@ actions:
done
exit 0
```
## Create a Backup Policy with the EDB hooks
1. Launch your Kasten K10 interface.
## Create a backup policy with the EDB hooks
2. Create a policy for the EDB namespace, you will need to set up a location profile for the export and kanister actions.
Add the hooks example:
![Kasten Backup Policy with EDB Hooks](Images/KastenBackupPolicywithHooks.png)
1. Launch the Kasten K10 interface.
2. Create a policy for the EDB namespace. You need to set up a location profile for the export and kanister actions.
3. Add the hooks example:
![Kasten Backup Policy with EDB Hooks](Images/KastenBackupPolicywithHooks.png)
41 changes: 20 additions & 21 deletions advocacy_docs/partner_docs/KastenbyVeeam/05-UsingVeeamKasten.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,43 +3,42 @@ title: 'Using'
description: 'Walkthrough of example usage scenarios'
---

When you have configured your Kubernetes environment per the `Configuring` section you will then be able to start taking backups and completing restores.
After you configure your Kubernetes environment, you can start taking backups and completing restores.

## Launch a Backup
## Launch a backup

1. Launch your Kasten K10 interface.

2. Use Kasten K10 to launch a backup that creates two restore points, a local and a remote.
2. Use Kasten K10 to launch a backup that creates two restore points: a local and a remote.

3. You now have a backup we can use to validate a restore in the next section.
3. You now have a backup to use to validate a restore.

![Launch a Backup](Images/LaunchaBackup.png)

!!! Note
The Kasten by Veeam backup process is explained below:
1. EDB elects a replica for the backup.
2. Kasten will discover the replica.
3. Kasten calls the EDB pre-backup command on the discovered replica.
4. The replica becomes ready for the backup.
5. Kasten takes the backup.
6. Kasten calls the EDB post backup command on the replica.
7. The replica leaves the backup mode.
8. The backup is then over and is consistent for a restore.

## Backup process summary

The Kasten by Veeam backup process is:
1. EDB elects a replica for the backup.
2. Kasten discovers the replica.
3. Kasten calls the EDB pre-backup command on the discovered replica.
4. The replica becomes ready for the backup.
5. Kasten takes the backup.
6. Kasten calls the EDB post-backup command on the replica.
7. The replica leaves the backup mode.
8. The backup is over and is consistent for a restore.

## Restore Database
## Restore database

1. To get ready for Kasten K10 to complete a restore, we will remove the EDB namespace in this example.
1. To get ready for Kasten K10 to complete a restore, remove the EDB namespace:

```bash
kubectl delete ns edb
```

2. In the Kasten K10 interface go to your remote restore point.
2. In the Kasten K10 interface, go to your remote restore point.

3. On the remote restore point select `restore`.
3. On the remote restore point, select **restore**.

4. After the restore is complete, all of your data will be present.
4. After the restore is complete, all of your data is present.
![Kasten Data Restore Point](Images/KastenRestorePoint.png)


Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: 'Certification Environment'
title: 'Certification environment'
description: 'Overview of the certification environment'
---

|   |   |
| ----------- | ----------- |
| **Certification Test Date** | August 28, 2023 |
| **Certification test date** | August 28, 2023 |
| **EDB Postgres for Kubernetes** | 1.20.2 |
| **EDB Postgres for Kubernetes External Backup Adapter** |
| **Kasten by Veeam Kasten K10** | 6.0 |
20 changes: 12 additions & 8 deletions advocacy_docs/partner_docs/KastenbyVeeam/07-SupportandLogging.mdx
Original file line number Diff line number Diff line change
@@ -1,29 +1,33 @@
---
title: 'Support and Logging Details'
title: 'Support and logging details'
description: 'Details of the support process and logging information'
---

## Support

Technical support for the use of these products is provided by both EDB and Veeam. A proper support contract is required to be in place at both EDB and Veeam. A support ticket can be opened on either side to start the process. If it is determined through the support ticket that resources from the other vendor is required, the customer should open a support ticket with that vendor through normal support channels. This will allow both companies to work together to help the customer as needed.
Technical support for the use of these products is provided by both EDB and Veeam. A support contract must be in place at both EDB and Veeam. You can open a support ticket with either company to start the process. If it's determined through the support ticket that resources from the other vendor are required, open a support ticket with that vendor through normal support channels. This approach allows both companies to work together to help you as needed.

## Logging

**EDB Postgres Advanced Server Logs**
The following log files are available.

Navigate to the `Data` directory in your chosen EDB Postgres Advanced Server instance and from here you can navigate to `log`, `current_logfiles` or you can navigate to the `postgresql.conf` file where you can customize logging options or enable `edb_audit` logs. An example of the full path to view EDB Postgres Advanced Server logs: `/var/lib/edb/as15/data/log`.
### EDB Postgres Advanced Server logs

**PostgreSQL Server Logs**
Navigate to the `Data` directory in your chosen EDB Postgres Advanced Server instance. From there, you can navigate to `log` or `current_logfiles`. Or, you can navigate to the `postgresql.conf` file, which you can use to customize logging options or enable `edb_audit` logs.

The default log directories for PostgreSQL logs vary depending on the operating system:
An example of the full path to view EDB Postgres Advanced Server logs is `/var/lib/edb/as15/data/log`.

### PostgreSQL Server logs

The default log directories for PostgreSQL logs depend on the operating system:

- Debian-based system: `/var/log/postgresql/postgresql-x.x.main.log. X.x.`

- Red Hat-based system: `/var/lib/pgsql/data/pg_log`

- Windows: `C:\Program Files\PostgreSQL\9.3\data\pg_log`

**Kasten by Veeam Logs**
### Kasten by Veeam logs

On the Kasten K10 UI navigate to `Settings` then `Support` then click `Download Logs`.
On the Kasten K10 interface, select **Settings > Support**, and then select **Download Logs**.
![Veeam Kasten Logs](Images/VeeamKastenLogging.png)
7 changes: 3 additions & 4 deletions advocacy_docs/partner_docs/KastenbyVeeam/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@ directoryDefaults:
iconName: handshake
---

<p align="center">
<img src="Images/PartnerProgram.jpg.png">
</p>
![Partner Program Logo](Images/PartnerProgram.jpg.png)

<h1 style="text-align: center;">EDB GlobalConnect Technology Partner Implementation Guide</h1>
<h3 style="text-align: center;">Kasten by Veeam for Kasten K10</h3>

<p style="text-align: center;">This document is intended to augment each vendor’s product documentation in order to guide the reader in getting the products working together. It is not intended to show the optimal configuration for the certified integration.</p>
<p style="text-align: center;">This document is intended to augment each vendor’s product documentation to guide you in getting the products working together. It isn't intended to show the optimal configuration for the certified integration.</p>
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,30 @@ When using Google Cloud, you can create clusters in the following regions.

## BigAnimal's cloud account

### Azure regions

When using Azure and BigAnimal's cloud account, you can create clusters in the following regions.

#### North America (NA)

| Cloud region | Short name |
| ------------------------ | -------------- |
| US East (Virginia) | eastus2 |
| Canada (Central) | canadacentral |


#### Asia and Pacific (APAC)

| Cloud region | Short name |
| ------------------------ | -------------- |
| Asia Pacific (Pune) | centralindia |

#### Europe, Middle East, and Africa (EMEA)

| Cloud region | Short name |
| ------------------ | ------------ |
| Europe (London) | uksouth |

### AWS regions

When using AWS and BigAnimal's cloud account, you can create clusters in the following regions.
Expand Down
Loading

2 comments on commit 7e3790f

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

πŸŽ‰ Published on https://edb-docs.netlify.app as production
πŸš€ Deployed on https://651ecdf73619dd0ce91184e0--edb-docs.netlify.app

Please sign in to comment.