这是indexloc提供的服务,不要输入任何密码
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions sites/platform/src/add-services/mysql/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ Their infrastructure setup is nearly identical, though they differ in some featu
See the [MariaDB documentation](https://mariadb.org/documentation/)
or the Oracle [MySQL Server documentation](https://dev.mysql.com/doc/refman/en/) for more information.

{{% note theme="info" title="MariaDB note" %}}
The [example](#mariadb-example) provided later in this topic is specific to using only a **primary** MariaDB database. For details about using read-only replicas to improve performance of read-heavy applications, see the [MariaDB read-only replication](/add-services/mysql/mysql-readonly-replication.md) topic.
{{% /note %}}


## Use a framework

If you use one of the following frameworks, follow its guide:
Expand Down Expand Up @@ -178,6 +183,10 @@ With the above definition, the application container now has [access to the serv

### MariaDB example

{{% note theme="info" %}}
Use the steps and sample code below if your application will connect to a **primary** MariaDB database. For details about using read-only replicas to improve performance of read-heavy applications, see the [MariaDB read-only replication](/add-services/mysql/mysql-readonly-replication.md) topic.
{{% /note %}}

#### [Service definition](/add-services/_index.md)

```yaml {configFile="services"}
Expand Down
137 changes: 137 additions & 0 deletions sites/platform/src/add-services/mysql/mysql-readonly-replication.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
---
title: "MariaDB read-only replication"
sidebarTitle: "MariaDB read-only replication"
description: Configure and access read-only MariaDB replicas to ease the load on a primary database.
---

You can improve the performance of read-heavy applications by defining read-only replicas of your MariaDB database and then connecting your application to those replicas.

Examples of read-heavy applications include:
- Listing pages or dashboards
- Reporting or analytics jobs
- Background jobs that frequently query data

{{< note theme="info" title="Note" >}}
- **To prevent data loss or interruptions** during replication, you must configure the disk size for each replica. The replica service does not inherit the disk size of the primary database. The replica disk size must at least match the primary service's disk capacity. See the example below.
- **Replication is asynchronous**: Delays of a few milliseconds might occur between writes on the primary database and reads on the replica database.
- **Replicas are read-only**: This restriction ensures data consistency and integrity. Attempts to modify data will result in an SQL error.
{{< /note >}}

### Read-only vs. external replicas
Read-only replicas are used primarily to improve application performance by distributing database read requests from read-heavy applications.

Other common use cases for read-only replicas include:
- Cross-region backup: Replicating data to different geographical regions
- Data warehousing: Extracting data from production to analytics projects

[External replicas](/add-services/mysql/mysql-replication.md) reside on remote servers and have different use cases, including disaster recovery.

### Replica scope and sharing services {#replica-scope-sharing-services}
MariaDB services (which provide access to databases and replicas) defined in a project cannot be accessed by or shared with applications in other projects.

To share the MariaDB service among applications in different projects, you must complete the following high-level steps:
1. Migrate the {{% vendor/name %}} projects to {{% vendor/company_name %}} Flex.
1. Migrate the applications that are in those projects.
1. Move the desired applications into one Flex project, rather than separate Flex projects. In {{% vendor/company_name %}} Flex, multiple applications in one project can share the same services.

For details, see [Converting from {{% vendor/name %}}](https://docs.upsun.com/learn/tutorials/migrating/from-fixed.html) in the {{% vendor/company_name %}} Flex product docs.

## 1. Configure the primary and replica services

The following code fragment defines two MariaDB services: a primary and a replica. You can use this fragment as a template by copying it into your `services.yaml` or `application.yaml` file.

Be sure to:
- Replace `<VERSION>` with the [supported MariaDB version](/add-services/mysql/_index.md#supported-versions) that you need. Use the same version number for the primary and replica services.
- Replace `<SIZE>` with a `disk` size in (MB) that is sufficient for the primary database's disk capacity.
- **Important:** Use `replicator` as the endpoint name when you define the replica service. This is a special endpoint name that the replica service uses to connect to the database.

```yaml {configFile="services"}
services:
db:
type: mariadb:<VERSION>
disk: <SIZE>
configuration:
schemas:
- main
endpoints:
main:
default_schema: main
privileges:
main: admin
replicator:
privileges:
main: replication

db-replica1:
type: mariadb-replica:<VERSION>
disk: <SIZE>
configuration:
schemas:
- main
endpoints:
main:
default_schema: main
privileges:
main: admin
relationships:
primary: db:replicator # Do not change the name `primary`. The service expects to receive this name.

db-replica2:
type: mariadb-replica:<VERSION>
disk: <SIZE>
configuration:
schemas:
- main
endpoints:
main:
default_schema: main
privileges:
main: admin
relationships:
primary: db:replicator # Do not change the name `primary`. The service expects to receive this name.
```

### How it works

Using the sample code fragment above:

1. The primary service (`db`) defines an additional `replicator` endpoint, granting the `replication` privilege. This enables a replica to connect and continuously replicate data from the primary database.

```yaml
replicator:
privileges:
main: replication
```

2. The replica services (`db-replica1` and `db-relica2`) use the `mariadb-replica` image type and connect back to the primary database service through the primary relationship. This establishes a replication link from `db` (the source) to `db-replica` (the target).

```yaml
relationships:
primary: db:replicator
```

The `db-replica1` and `db-replica2` replica services continuously stream data from the primary endpoint, maintaining a read-only copy of the primary database content. Write operations are not permitted on the replicas.


## 2. Define the relationship between the application and the replicas

Even if your application won't access the replication endpoint, you must expose the endpoint to an application as a relationship so that you can connect to it over SSH.

Add a new relationship to your application container, as shown below:

```yaml {configFile="app"}
name: myapp

[...]

# Relationships enable an app container's access to a service.
relationships:
# More information: https://fixed.docs.upsun.com/anchors/fixed/app/reference/relationships/
database:
service: db
endpoint: main
database-readonly:
service: db-replica
```


6 changes: 3 additions & 3 deletions sites/platform/src/add-services/mysql/mysql-replication.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "MariaDB/MySQL External Replication"
sidebarTitle: "MariaDB/MySQL Replication"
title: "MariaDB/MySQL external replication"
sidebarTitle: "External replication"
description: In rare cases, it may be useful to maintain a replica instance of your MySQL/MariaDB database outside of {{% vendor/name %}}.
---

In rare cases, it may be useful to maintain a replica instance of your MySQL/MariaDB database outside of {{% vendor/name %}}.
In rare cases, it may be useful to maintain a replica instance of your MySQL/MariaDB database outside of {{% vendor/name %}} on a remote server.

Typically, an automated backup is better for short-term usage and a `mysqldump` for longer term storage, but in some cases the data set is large enough that `mysqldump` is prohibitive.
In that case, you can enable external replication using an extra permission.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ PostgreSQL is a high-performance, standards-compliant relational SQL database.

See the [PostgreSQL documentation](https://www.postgresql.org/docs/9.6/index.html) for more information.

{{% note theme="info" title="Note" %}}
The [example](#usage-example) provided later in this topic is specific to using only a **primary** database. For details about using read-only replicas to improve performance of read-heavy applications, see the [PostgreSQL read-only replication](/add-services/postgresql/postgresql-readonly-replication.md) topic.
{{% /note %}}

## Use a framework

If you use one of the following frameworks, follow its guide:
Expand Down Expand Up @@ -97,6 +101,10 @@ So your apps should only rely on the `{{% vendor/prefix %}}_RELATIONSHIPS` envir

## Usage example

{{% note theme="info" %}}
Use the steps and sample code below if your application will connect to a **primary** PostgreSQL database. For details about using read-only replicas to improve performance of read-heavy applications, see the [PostgreSQL read-only replication](/add-services/postgresql/postgresql-readonly-replication.md) topic.
{{% /note %}}

### 1. Configure the service

To define the service, use the `postgresql` type:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
---
title: "PostgreSQL read-only replication"
sidebarTitle: "Read-only replication"
description: Configure and access read-only PostgreSQL replicas to ease the load on a primary database.
---

You can improve the performance of read-heavy applications by defining read-only replicas of your PostgreSQL database and then connecting your application to those replicas.

Examples of read-heavy applications include:
- Listing pages or dashboards
- Reporting or analytics jobs
- Background jobs that frequently query data

{{< note theme="info" title="Note" >}}
- **To prevent data loss or interruptions** during replication, you must configure the disk size for each replica. The replica service does not inherit the disk size of the primary database. The replica disk size must at least match the primary service's disk capacity. See the example below.
- **Replication is asynchronous**: Delays of a few milliseconds might occur between writes on the primary database and reads on the replica database.
- **Replicas are read-only**: This restriction ensures data consistency and integrity. Attempts to modify data will result in an SQL error.
{{< /note >}}

### Replica scope and sharing services {#replica-scope-sharing-services}
PostgreSQL services (which provide access to databases and replicas) defined in a project cannot be accessed by or shared with applications in other projects.

To share the PostgreSQL service among applications in different projects, you must complete the following high-level steps:
1. Migrate the projects to {{% vendor/company_name %}} Flex.
1. Migrate the applications that are in those projects.
1. Move the desired applications into one Flex project, rather than separate Flex projects. In {{% vendor/company_name %}} Flex, multiple applications in one project can share the same services.

For details, see [Converting from {{% vendor/name %}}](https://docs.upsun.com/learn/tutorials/migrating/from-fixed.html) in the {{% vendor/company_name %}} Flex product docs.

## 1. Configure the primary and replica services

The following code fragment defines two MariaDB services: a primary and a replica. You can use this fragment as a template by copying it into your `services.yaml` or `application.yaml` file.

Be sure to:
- Replace `<VERSION>` with the [supported PostgreSQL version](/add-services/postgresql/_index.md#supported-versions) that you need. Use the same version number for the primary and replica services.
- Replace `<SIZE>` with a `disk` size in (MB) that is sufficient for the primary database's disk capacity.
- **Important:** Use `replicator` as the endpoint name when you define the replica service. This is a special endpoint name that the replica service uses to connect to the database.

```yaml {configFile="services"}
services:
db:
type: postgresql:<VERSION>
disk: <SIZE>
configuration:
extensions:
- postgis
endpoints:
replicator:
replication: true

db-replica1:
type: postgres-replica:<VERSION>
disk: <SIZE>
configuration:
endpoints:
postgresql:
default_database: main
extensions:
- postgis
relationships:
primary: db:replicator # Do not change the name `primary`. The service expects to receive this name.

db-replica2:
type: postgres-replica:<VERSION>
disk: <SIZE>
configuration:
endpoints:
postgresql:
default_database: main
extensions:
- postgis
relationships:
primary: db:replicator # Do not change the name `primary`. The service expects to receive this name.
```

### How it works

Using the sample code fragment above:

1. After you define the replicator endpoints, the primary service creates a `replicator` user that has permission to replicate the database. You must specify `replicator` as the endpoint name, as described at the start of this topic.

```yaml
endpoints:
replicator:
replication: true
```

2. In the replica services (in this example, db-replica1 and db-replica2), defining the relationship `primary: db:replicator` ensures that the service can connect to the primary database as the `replicator` user.

```yaml
relationships:
primary: db:replicator
```

The `db-replica1` and `db-replica2` replica services continuously stream data from the primary endpoint, maintaining a read-only copy of the primary database content. Write operations are not permitted on the replicas.


## 2. Define the relationship between the application and the replicas

Even if your application won't access the replication endpoint, you must expose the endpoint to an application as a relationship so that you can connect to it over SSH.

Add a new relationship to your application container, as shown below:

```yaml {configFile="app"}
name: myapp

[...]

# Relationships enable an app container's access to a service.
relationships:
# More information: https://fixed.docs.upsun.com/anchors/fixed/app/reference/relationships/
database:
service: db
endpoint: main
database-readonly:
service: db-replica
```


9 changes: 9 additions & 0 deletions sites/upsun/src/add-services/mysql/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ Their infrastructure setup is nearly identical, though they differ in some featu
See the [MariaDB documentation](https://mariadb.org/documentation/)
or the Oracle [MySQL Server documentation](https://dev.mysql.com/doc/refman/en/) for more information.

{{% note theme="info" title="MariaDB note" %}}
The [example](#mariadb-example) provided later in this topic is specific to using only a **primary** MariaDB database. For details about using read-only replicas to improve performance of read-heavy applications, see the [MariaDB read-only replication](/add-services/mysql/mysql-readonly-replication.md) topic.
{{% /note %}}


## Supported versions

You can select the major and minor version.
Expand Down Expand Up @@ -307,6 +312,10 @@ With the above definition, the application container now has [access to the serv

### MariaDB example

{{% note theme="info" %}}
Use the steps and sample code below if your application will connect to a **primary** MariaDB database. For details about using read-only replicas to improve performance of read-heavy applications, see the [MariaDB read-only replication](/add-services/mysql/mysql-readonly-replication.md) topic.
{{% /note %}}

{{< codetabs >}}

+++
Expand Down
Loading
Loading