Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DMS] March release branch, release Thursday 27 #6603

Merged
merged 23 commits into from
Mar 27, 2025

Conversation

gvasquezvargas
Copy link
Contributor

@gvasquezvargas gvasquezvargas commented Mar 11, 2025

What Changed?

Created a march release branch for the DMS so we can track all the work together on this branch.

If you want to make edits, create a PR off of this branch.

https://enterprisedb.atlassian.net/browse/DOCS-1270

@gvasquezvargas gvasquezvargas requested a review from a team as a code owner March 11, 2025 19:23
@gvasquezvargas gvasquezvargas added the deploy Add this label to a PR and it will automatically be deployed to netlify label Mar 12, 2025
Copy link
Contributor

github-actions bot commented Mar 12, 2025

@github-actions github-actions bot temporarily deployed to pull request March 12, 2025 08:57 Inactive
Copy link
Contributor Author

@gvasquezvargas gvasquezvargas left a comment

Choose a reason for hiding this comment

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

Hey @yidian1997, thanks for the new content! I left a few comments for you, feel free to batch-commit them if you agree.

@github-actions github-actions bot temporarily deployed to pull request March 12, 2025 09:41 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 12, 2025 11:03 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 17, 2025 09:49 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 17, 2025 10:20 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 17, 2025 16:37 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 19, 2025 15:17 Inactive
Copy link

@jperozoa jperozoa left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Contributor

@mlewandowski-edb mlewandowski-edb left a comment

Choose a reason for hiding this comment

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

I've finished a partial review of the DMS documentation updates.


- The maximum character length for the ID is 255 characters.
- You can use lowercase and uppercase characters, numbers, underscores(_) and hyphens(-) for the ID. Other special characters are not supported.
- The ID must be unique. The target instances cannot have the same ID.
Copy link
Contributor

Choose a reason for hiding this comment

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

What does this mean?

The target instances cannot have the same ID.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think I meant to say "Two target instances cannot have the same ID", but thinking about this more, I think we can get rid of the second sentence altogether, WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think the second sentence should be removed. However, I wonder if we need to be clearer about in what context the ID should be unique. I think ID must be unique from the perspective that it must not be the same as the name of any other currently running writers. Presumably readers have this same uniqueness constraint across other running readers.

@jperozoa or @yidian1997 can readers and writers have the same ID? Also, is uniqueness required across an entire HCP deployment or is uniqueness only required within the context of an HCP project? In other words, would it be accurate to say that two currently running readers or two currently running writers can have the same ID if they are in different projects? Or would it be accurate to say the no two currently running readers and no two currently running writers attached to the HCP, independent of the HCP project, can have the same ID?

The Apicurio client uses it to perform mTLS authentication with the `transporter-rw-service`.

### `AWS_ACCESS_KEY_ID`
1) If you are using AWS S3, set this value to an access key ID that has read and write permissions for the S3 bucket.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this a setting for something that is in a user's environment or in the HCP deployment environment? If the latter, is this a value that a user of the HCP will know or will they have to get this from an administrator? This should be clearer. And, if it is something that is specified in the HCP configuration, the admin's, who may not have set up the HCP, will need to know how find it.

@jperozoa @yidian1997 Settings like this and the RW_SERVICE_HOST have me wondering if there is a way for a user to have an environment specific run-cdcreader.sh and run-cdcwriter.sh files generated for them that would populate some of these values for them based on the HCP deployment.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think those access key related values should get from administrator.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Who can we ask more about this? If an admin needs to provide this information, where does he/she get it?

Do they check in their AWS console? Is there a command they can run to fetch this and all subsequent values that start with AWS_? Or maybe all these values are related to something established during the installation of the HCP?

Copy link
Contributor

Choose a reason for hiding this comment

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

Also, in a conversation I had with @jperozoa earlier today, it's my understanding that these S3 related settings are only required if you have large rows in your source database that needs to be migrated. As I understand it, transporter can actually migrate the large rows, but setting these variables will improve performance of migrating large rows. If they are optional, we should note that they are optional but recommended and provide their purpose/benefit.

2) If you are using S3-compatible storage, like MinIO, set this value to the access key for your object storage.

### `AWS_SECRET_ACCESS_KEY`
1) If you are using AWS S3, set this value to a secret access key that has read and write permissions for the specified S3 bucket.
Copy link
Contributor

Choose a reason for hiding this comment

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

I have the same question here as I did in my comment under to the AWS_ACCESS_KEY_ID setting.

@@ -29,8 +29,7 @@ Before you begin the installation process:

- Activate the required SUSE module:
```shell
sudo SUSEConnect -p PackageHub/12.5/x86_64
sudo SUSEConnect -p sle-sdk/12.5/x86_64
sudo SUSEConnect -p PackageHub/15.4/x86_64
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if this is correct? Does the .4 correspond to the Service Pack number? If so, I think SLES 15 SP 6 is the version we now support.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@yidian1997 is Matt's suggestions correct?

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for the comments, today I took some time to investigate this and found that the current doc steps are different from the current instructions shown inthe EDB repository. I need ask some questions to the foundation team

Copy link
Contributor

@yidian1997 yidian1997 Mar 25, 2025

Choose a reason for hiding this comment

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

The question I asked in the foundation: https://edb.slack.com/archives/C0413N9LGVB/p1742890896071419

@@ -0,0 +1,36 @@
---
navTitle: Ubuntu 20.04
Copy link
Contributor

Choose a reason for hiding this comment

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

I believe Ubuntu 20.04 has reached End of Life and we will no longer be supporting it by the end of March 2025. However, the plan is to start to support Ubuntu 24.04 this quarter (Q1 2025).

So, I think this page is not needed, but a 24.04 page will be needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Got it, will remove in the next commit.

@github-actions github-actions bot temporarily deployed to pull request March 24, 2025 11:42 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 25, 2025 15:46 Inactive
Copy link
Contributor

@mlewandowski-edb mlewandowski-edb left a comment

Choose a reason for hiding this comment

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

Finished reviewing remaining files and files that have been changed since my last review.
Sorry for all the comments on references to Ubuntu 20, which is out of support. I suspect there is a plan to take care of them, but I didn't want to assume all the references were well known.

The Apicurio client uses it to perform mTLS authentication with the `transporter-rw-service`.

### `AWS_ACCESS_KEY_ID`
1) If you are using AWS S3, set this value to an access key ID that has read and write permissions for the S3 bucket.
Copy link
Contributor

Choose a reason for hiding this comment

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

Also, in a conversation I had with @jperozoa earlier today, it's my understanding that these S3 related settings are only required if you have large rows in your source database that needs to be migrated. As I understand it, transporter can actually migrate the large rows, but setting these variables will improve performance of migrating large rows. If they are optional, we should note that they are optional but recommended and provide their purpose/benefit.

@github-actions github-actions bot temporarily deployed to pull request March 25, 2025 21:15 Inactive
@gvasquezvargas gvasquezvargas force-pushed the data_mig_service/march_release_branch branch from 4122759 to 54bbd59 Compare March 26, 2025 12:36
@github-actions github-actions bot temporarily deployed to pull request March 26, 2025 12:48 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 26, 2025 16:13 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 26, 2025 16:35 Inactive
@gvasquezvargas gvasquezvargas changed the title DMS: March release branch [DMS] March release branch, release Thursday 27 Mar 27, 2025
yidian1997 and others added 21 commits March 27, 2025 10:13
…vice/getting_started/config_writer.mdx

Co-authored-by: gvasquezvargas <[email protected]>
…vice/getting_started/config_writer.mdx

Co-authored-by: gvasquezvargas <[email protected]>
…vice/getting_started/config_writer.mdx

Co-authored-by: gvasquezvargas <[email protected]>
…vice/getting_started/config_writer.mdx

Co-authored-by: gvasquezvargas <[email protected]>
…vice/getting_started/config_writer.mdx

Co-authored-by: gvasquezvargas <[email protected]>
…vice/getting_started/config_writer.mdx

Co-authored-by: gvasquezvargas <[email protected]>
…vice/getting_started/config_writer.mdx

Co-authored-by: gvasquezvargas <[email protected]>
…vice/getting_started/index.mdx

Co-authored-by: gvasquezvargas <[email protected]>
@gvasquezvargas gvasquezvargas force-pushed the data_mig_service/march_release_branch branch from 7be3f75 to 2e76fa0 Compare March 27, 2025 09:13
@github-actions github-actions bot temporarily deployed to pull request March 27, 2025 09:17 Inactive
Comment on lines +6 to +36
## Prerequisites

Before you begin the installation process:

- Set up the EDB repository.

Setting up the repository is a one-time task. If you have already set up your repository, you don't need to perform this step.

To determine if your repository exists, enter this command:

`dnf repolist | grep enterprisedb`

If no output is generated, the repository isn't installed.

To set up the EDB repository:

1. Go to [EDB repositories](https://www.enterprisedb.com/repos-downloads).

1. Select the button that provides access to the EDB repository.

1. Select the platform and software that you want to download.

1. Follow the instructions for setting up the EDB repository.

## Install the package

Install the EDB DMS Writer (packaged as `cdcwriter`):

```shell
sudo dnf install cdcwriter
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## Prerequisites
Before you begin the installation process:
- Set up the EDB repository.
Setting up the repository is a one-time task. If you have already set up your repository, you don't need to perform this step.
To determine if your repository exists, enter this command:
`dnf repolist | grep enterprisedb`
If no output is generated, the repository isn't installed.
To set up the EDB repository:
1. Go to [EDB repositories](https://www.enterprisedb.com/repos-downloads).
1. Select the button that provides access to the EDB repository.
1. Select the platform and software that you want to download.
1. Follow the instructions for setting up the EDB repository.
## Install the package
Install the EDB DMS Writer (packaged as `cdcwriter`):
```shell
sudo dnf install cdcwriter
```
# Install using system package manager
## Prerequisites
Before you begin the installation process:
- Set up the EDB repository.
Setting up the repository is a one-time task. If you have already set up your repository, you don't need to perform this step.
To determine if your repository exists, enter this command:
`dnf repolist | grep enterprisedb`
If no output is generated, the repository isn't installed.
To set up the EDB repository:
1. Go to [EDB repositories](https://www.enterprisedb.com/repos-downloads).
1. Select the button that provides access to the EDB repository.
1. Select the platform and software that you want to download.
1. Follow the instructions for setting up the EDB repository.
## Install the package
Install the EDB DMS Writer (packaged as `cdcwriter`) according to the instruction in EDB repositories
Example:
```shell
sudo dnf install cdcwriter
# Install using EDB provided installer
## Download EDB software installer from browser
1. Go to [EDB repositories](https://www.enterprisedb.com/repos-downloads).
2. Select the button that provides access to the EDB repository.
3. Select the platform and software that you want to download.
4. Go to the `Enterprise` link under the `Download EDB software packages from your browser` section
5. Download the cdcwriter installer
## Install the package
Install the EDB DMS Writer (packaged as `cdcwriter`) using the installer.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @gvasquezvargas After the investigation, I found we have two approaches to installing the reader and writer.

  1. Using system package manager
    Currently missing cdcreader and cdcwriter in the software list, pending fix.
  2. Using the EDB-provided installer
    Can find our installer in the list

So I propose such kind of change to let user can choose the way to download and install they want to use. What do your think?

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor

@jpe442 jpe442 left a comment

Choose a reason for hiding this comment

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

LGTM

@gvasquezvargas gvasquezvargas merged commit 7693cc2 into develop Mar 27, 2025
6 checks passed
@gvasquezvargas gvasquezvargas deleted the data_mig_service/march_release_branch branch March 27, 2025 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deploy Add this label to a PR and it will automatically be deployed to netlify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants