Skip to content

Commit

Permalink
Merge pull request #474 from Qovery/fix-guide-rds
Browse files Browse the repository at this point in the history
fix database metadata and guide page
  • Loading branch information
jul-dan authored Sep 27, 2024
2 parents 809cdda + 8b0e9f4 commit 7b070b6
Show file tree
Hide file tree
Showing 8 changed files with 37 additions and 17 deletions.
2 changes: 1 addition & 1 deletion .meta/.schemas/guides.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
"description": "Array of tags",
"items": {
"type": "string",
"enum": ["type: guide","type: post","type: tutorial","type: engineering","domain: buffers","domain: cli","domain: config","domain: dependencies","domain: networking","domain: observability","domain: operations","domain: platforms","domain: security","domain: sinks","domain: sources","domain: tests","domain: topology","domain: transforms","domain: ux","domain: website","domain: services","language: php","language: kotlin","language: java","language: javascript","language: python","language: rust","language: go","language: ruby","language: scala","database: mysql","database: postgresql","database: mongodb","framework: hasura","framework: laravel","framework: springboot","framework: nodejs","framework: flask","framework: jhipster","framework: gin","framework: rails","framework: django","framework: deno","framework: strapi","framework: nuxtjs","framework: sinatra","framework: meilisearch","technology: kubernetes","technology: helm","technology: docker","technology: kotlin","technology: qovery","technology: posthog","technology: terraform","technology: github","installation_guide: aws","installation_guide: digital_ocean","installation_guide: scaleway","installation_guide: gcp","installation_guide: azure","installation_guide: kubernetes"]
"enum": ["type: guide","type: post","type: tutorial","type: engineering","domain: buffers","domain: cli","domain: config","domain: dependencies","domain: networking","domain: observability","domain: operations","domain: platforms","domain: security","domain: sinks","domain: sources","domain: tests","domain: topology","domain: transforms","domain: ux","domain: website","domain: services","language: php","language: kotlin","language: java","language: javascript","language: python","language: rust","language: go","language: ruby","language: scala","database: mysql","database: postgresql","database: mongodb","database: rds","framework: hasura","framework: laravel","framework: springboot","framework: nodejs","framework: flask","framework: jhipster","framework: gin","framework: rails","framework: django","framework: deno","framework: strapi","framework: nuxtjs","framework: sinatra","framework: meilisearch","technology: kubernetes","technology: helm","technology: docker","technology: kotlin","technology: qovery","technology: posthog","technology: terraform","technology: github","installation_guide: aws","installation_guide: digital_ocean","installation_guide: scaleway","installation_guide: gcp","installation_guide: azure","installation_guide: kubernetes"]
}
},
"title": {
Expand Down
5 changes: 5 additions & 0 deletions .meta/databases.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,8 @@ dark_logo_path = "/img/logos/docker.svg"
name = "mongodb"
logo_path = "/img/logos/docker.svg"
dark_logo_path = "/img/logos/docker.svg"

[[databases]]
name = "rds"
logo_path = "/img/logos/aws.svg"
dark_logo_path = "/img/logos/aws_white.svg"
12 changes: 6 additions & 6 deletions website/guides/advanced/adding-multi-region-backup-rds.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
last_modified_on: "2024-09-26"
last_modified_on: "2024-09-27"
$schema: "/.meta/.schemas/guides.json"
title: Enable multi-region backup on your RDS instances with AWS Backup
description: Learn how to enable the multi-region backup on your RDS instance (PostgreSQL, MySQL) via the AWS Backup feature
author_github: https://github.com/acarranoqovery
tags: ["type: guide", "technology: qovery"]
tags: ["type: guide", "database: rds"]
---
import Steps from '@site/src/components/Steps';
import Assumptions from '@site/src/components/Assumptions';
Expand All @@ -19,11 +19,11 @@ This guide will help you configure an AWS Backup job to create additional backup

For more information about AWS Backup, have a look at [this documentation](https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html).

Alert type="warning">
<Alert type="warning">
Cost Considerations: Setting up multi-region backups will incur additional costs. These costs include:
- Storage costs for the backup data in the secondary region
- Data transfer costs for copying the backup data between regions
- Potential costs for restoring from a backup in a different region
1) Storage costs for the backup data in the secondary region
2) Data transfer costs for copying the backup data between regions
3) Potential costs for restoring from a backup in a different region
Be sure to review the AWS Backup pricing and AWS data transfer pricing to estimate the costs for your specific use case. You can use AWS Cost Explorer to monitor these costs over time.
</Alert>

Expand Down
10 changes: 5 additions & 5 deletions website/guides/advanced/adding-multi-region-backup-rds.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ $schema: "/.meta/.schemas/guides.json"
title: Enable multi-region backup on your RDS instances with AWS Backup
description: Learn how to enable the multi-region backup on your RDS instance (PostgreSQL, MySQL) via the AWS Backup feature
author_github: https://github.com/acarranoqovery
tags: ["type: guide", "technology: qovery"]
tags: ["type: guide", "database: rds"]
---
import Steps from '@site/src/components/Steps';
import Assumptions from '@site/src/components/Assumptions';
Expand All @@ -18,11 +18,11 @@ This guide will help you configure an AWS Backup job to create additional backup

For more information about AWS Backup, have a look at [this documentation](https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html).

Alert type="warning">
<Alert type="warning">
Cost Considerations: Setting up multi-region backups will incur additional costs. These costs include:
- Storage costs for the backup data in the secondary region
- Data transfer costs for copying the backup data between regions
- Potential costs for restoring from a backup in a different region
1) Storage costs for the backup data in the secondary region
2) Data transfer costs for copying the backup data between regions
3) Potential costs for restoring from a backup in a different region
Be sure to review the AWS Backup pricing and AWS data transfer pricing to estimate the costs for your specific use case. You can use AWS Cost Explorer to monitor these costs over time.
</Alert>

Expand Down
6 changes: 3 additions & 3 deletions website/guides/advanced/upgrading-rds-instance.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
last_modified_on: "2024-09-18"
last_modified_on: "2024-09-27"
$schema: "/.meta/.schemas/guides.json"
title: Minimize downtime while upgrading RDS instances
description: Learn how to upgrade your RDS instance (PostgreSQL, MySql) minimizing your downtime with Qovery and Blue Green deployments
author_github: https://github.com/acarranoqovery
tags: ["type: guide", "technology: qovery"]
tags: ["type: guide", "database: rds", "domain: operations"]
---
import Steps from '@site/src/components/Steps';
import Assumptions from '@site/src/components/Assumptions';
Expand Down Expand Up @@ -32,7 +32,7 @@ To better explain the process, we will try to upgrade an RDS PostgreSQL instance
website/guides/advanced/upgrading-rds-instance.md.erb
-->

## Activate the logical replication
## Activate the logical replication

<Alert type="info">

Expand Down
4 changes: 2 additions & 2 deletions website/guides/advanced/upgrading-rds-instance.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ $schema: "/.meta/.schemas/guides.json"
title: Minimize downtime while upgrading RDS instances
description: Learn how to upgrade your RDS instance (PostgreSQL, MySql) minimizing your downtime with Qovery and Blue Green deployments
author_github: https://github.com/acarranoqovery
tags: ["type: guide", "technology: qovery"]
tags: ["type: guide", "database: rds", "domain: operations"]
---
import Steps from '@site/src/components/Steps';
import Assumptions from '@site/src/components/Assumptions';
Expand All @@ -23,7 +23,7 @@ Blue/Green deployments on RDS are not natively supported by Qovery but you can f

To better explain the process, we will try to upgrade an RDS PostgreSQL instance from the version 14 to the version 15.

## Activate the logical replication
## Activate the logical replication

<Alert type="info">

Expand Down
5 changes: 5 additions & 0 deletions website/metadata.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ module.exports = {
"dark_logo_path": "/img/logos/docker.svg",
"logo_path": "/img/logos/docker.svg",
"name": "mongodb"
},
{
"dark_logo_path": "/img/logos/aws_white.svg",
"logo_path": "/img/logos/aws.svg",
"name": "rds"
}
],
"event_types": [
Expand Down
10 changes: 10 additions & 0 deletions website/src/theme/GuideItem/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ function GuideItem(props) {
const frameworkName = frameworkTag ? frameworkTag.value : null;
const technologyTag = enrichedTags.find(tag => tag.category == 'technology');
const technologyName = technologyTag ? technologyTag.value : null;
const databaseTag = enrichedTags.find(tag => tag.category == 'database');
const databaseName = databaseTag ? databaseTag.value : null;
const installationGuideTag = enrichedTags.find(tag => tag.category == 'installation_guide');
const installationGuideName = installationGuideTag ? installationGuideTag.value : null;
const platformTag = enrichedTags.find(tag => tag.category == 'platform');
Expand All @@ -43,6 +45,7 @@ function GuideItem(props) {
sinks,
languages,
frameworks,
databases,
technologies,
installation_guides
}
Expand All @@ -53,6 +56,7 @@ function GuideItem(props) {
const sink = sinkName && sinks[sinkName];
const language = languageName && languages.find(x => x.name === languageName);
const framework = frameworkName && frameworks.find(x => x.name === frameworkName);
const database = databaseName && databases.find(x => x.name === databaseName);
const technology = technologyName && technologies.find(x => x.name === technologyName);
const installationGuide = installationGuideName && installation_guides.find(x => x.name === installationGuideName);
const sourceIcon = (platform || source) !== null;
Expand All @@ -72,6 +76,12 @@ function GuideItem(props) {
} else {
sourceLogoPath = technology.logo_path;
}
} else if (database) {
if (isDarkTheme) {
sourceLogoPath = database.dark_logo_path;
} else {
sourceLogoPath = database.logo_path;
}
} else if (installationGuide) {
if (isDarkTheme) {
sourceLogoPath = installationGuide.dark_logo_path;
Expand Down

0 comments on commit 7b070b6

Please sign in to comment.