Updated RELEASE-NOTES.md file for 1.24 version#396
Conversation
vladsha-dev
temporarily deployed
to
Quality Environment
GitHub Actions
Inactive
vladsha-dev
temporarily deployed
to
Quality Environment
GitHub Actions
Inactive
vladsha-dev
temporarily deployed
to
Quality Environment
GitHub Actions
Inactive
vladsha-dev
temporarily deployed
to
Quality Environment
GitHub Actions
Inactive
vladsha-dev
temporarily deployed
to
Quality Environment
GitHub Actions
Inactive
vladsha-dev
temporarily deployed
to
Quality Environment
GitHub Actions
Inactive
vladsha-dev
temporarily deployed
to
Quality Environment
GitHub Actions
Inactive
vladsha-dev
temporarily deployed
to
Quality Environment
GitHub Actions
Inactive
vladsha-dev
temporarily deployed
to
Quality Environment
GitHub Actions
Inactive
vladsha-dev
temporarily deployed
to
Quality Environment
GitHub Actions
Inactive
vladsha-dev
temporarily deployed
to
Quality Environment
GitHub Actions
Inactive
vladsha-dev
temporarily deployed
to
Quality Environment
GitHub Actions
Inactive
vladsha-dev
temporarily deployed
to
Quality Environment
GitHub Actions
Inactive
vladsha-dev
temporarily deployed
to
Quality Environment
GitHub Actions
Inactive
|
vladsha-dev
temporarily deployed
to
Quality Environment
GitHub Actions
Inactive
React App | Jest test suite - Code coverage reportTotal: 25.86%Your code coverage diff: 0.00% ▴ ✅ All code changes are covered |
WalkthroughThe pull request introduces release notes for version 1.24.0 of the Open Supply Hub project. It highlights significant updates, including an upgrade to OpenSearch version 2.15 and detailed deployment instructions for Staging and Production environments. The release notes also retain historical information from previous versions, documenting changes such as database migrations, API modifications, and bug fixes, while emphasizing the importance of managing IAM user permissions and clearing OpenSearch indexes during the upgrade process. Changes
Possibly related PRs
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
doc/release/RELEASE-NOTES.md (3)
33-43: Standardize list marker styleFor better maintainability and consistency, use asterisks (*) instead of dashes (-) for unordered lists.
- 1. Run the `[Release] Deploy` pipeline for these environments with the flag 'Clear OpenSearch indexes' set to true. This will allow Logstash to refill OpenSearch since the OpenSearch instance will be recreated due to the version increase. - 2. Open the triggered `Deploy to AWS` workflow and ensure that the `apply` job is completed. **Right after** finishing the `apply` job, follow these instructions, which should be the last steps in setting up the recreated OpenSearch instance: - - Copy the ARN of the `terraform_ci` user from the AWS IAM console. - - Navigate to the AWS console's search input, type "IAM", and open the IAM console. - - In the IAM console, find and click on the "Users" tab. - - In the list of available users, locate the `terraform_ci` user, click on it, and on that page, you will find its ARN. - - After copying this value, go to the AWS OpenSearch console in the same way you accessed the IAM console. - - Open the available domains and locate the domain for the corresponding environment. Open it, then navigate to the security configuration and click "Edit". - - Find the section titled "Fine-grained access control", and under this section, you will find an "IAM ARN" input field. Paste the copied ARN into this field and save the changes. It may take several minutes to apply. Make sure that the "Configuration change status" field has green status. + 1. Run the `[Release] Deploy` pipeline for these environments with the flag 'Clear OpenSearch indexes' set to true. This will allow Logstash to refill OpenSearch since the OpenSearch instance will be recreated due to the version increase. + 2. Open the triggered `Deploy to AWS` workflow and ensure that the `apply` job is completed. **Right after** finishing the `apply` job, follow these instructions, which should be the last steps in setting up the recreated OpenSearch instance: + * Copy the ARN of the `terraform_ci` user from the AWS IAM console. + * Navigate to the AWS console's search input, type "IAM", and open the IAM console. + * In the IAM console, find and click on the "Users" tab. + * In the list of available users, locate the `terraform_ci` user, click on it, and on that page, you will find its ARN. + * After copying this value, go to the AWS OpenSearch console in the same way you accessed the IAM console. + * Open the available domains and locate the domain for the corresponding environment. Open it, then navigate to the security configuration and click "Edit". + * Find the section titled "Fine-grained access control", and under this section, you will find an "IAM ARN" input field. Paste the copied ARN into this field and save the changes. It may take several minutes to apply. Make sure that the "Configuration change status" field has green status.🧰 Tools
🪛 Markdownlint
36-36: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
37-37: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
38-38: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
39-39: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
40-40: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
41-41: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
42-42: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
Line range hint
8-9: Update release dateThe release date is set to November 16, 2024, which is in the future. Please update it to reflect the actual release date.
🧰 Tools
🪛 Markdownlint
36-36: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
37-37: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
38-38: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
39-39: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
40-40: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
41-41: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
42-42: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
32-32: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
Line range hint
11-31: Complete placeholder sectionsSeveral sections contain placeholder text (Describe X here). Please complete these sections with actual changes:
- Database migrations
- Scheme changes
- Code/API changes
- Bugfix
- What's new
This will help users understand the full scope of changes in this release.
🧰 Tools
🪛 Markdownlint
36-36: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
37-37: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
38-38: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
39-39: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
40-40: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
41-41: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
42-42: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
32-32: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
doc/release/RELEASE-NOTES.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint
doc/release/RELEASE-NOTES.md
36-36: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
37-37: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
38-38: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
39-39: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
40-40: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
41-41: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
42-42: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
🔇 Additional comments (1)
doc/release/RELEASE-NOTES.md (1)
33-43: LGTM - Deployment instructions are clear and comprehensive
The deployment instructions provide a clear, step-by-step guide with proper emphasis on critical timing and verification steps.
🧰 Tools
🪛 Markdownlint
36-36: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
37-37: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
38-38: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
39-39: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
40-40: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
41-41: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
42-42: Expected: asterisk; Actual: dash
Unordered list style
(MD004, ul-style)
vladsha-dev
temporarily deployed
to
Quality Environment
GitHub Actions
Inactive
Dedupe Hub App | Unittest test suite - Code coverage reportTotal: 56.14%Your code coverage diff: 0.00% ▴ ✅ All code changes are covered |
vladsha-dev
temporarily deployed
to
Quality Environment
GitHub Actions
Inactive
Countries App | Unittest test suite - Code coverage reportTotal: 100%Your code coverage diff: 0.00% ▴ ✅ All code changes are covered |
vladsha-dev
temporarily deployed
to
Quality Environment
GitHub Actions
Inactive
Contricleaner App | Unittest test suite - Code coverage reportTotal: 98.91%Your code coverage diff: 0.00% ▴ ✅ All code changes are covered |
vladsha-dev
temporarily deployed
to
Quality Environment
GitHub Actions
Inactive
Django App | Unittest test suite - Code coverage reportTotal: 77.93%Your code coverage diff: 0.00% ▴ ✅ All code changes are covered |
Right now, to enable access from EC2 to OpenSearch, the IAM ARN of the special Terraform user needs to be added to the master user settings associated with the OpenSearch instance. Since it’s not possible to set multiple master users via Terraform, you will need to add one more manually through the AWS console, as this is permitted. As the OpenSearch instance will be recreated during the release of version 1.24, the necessary instructions have been provided in the corresponding release notes 1.24 to reestablish access from EC2 to OpenSearch for clearing OpenSearch indexes.
4 participants
Right now, to enable access from EC2 to OpenSearch, the IAM ARN of the special Terraform user needs to be added to the master user settings associated with the OpenSearch instance. Since it’s not possible to set multiple master users via Terraform, you will need to add one more manually through the AWS console, as this is permitted.
As the OpenSearch instance will be recreated during the release of version 1.24, the necessary instructions have been provided in the corresponding release notes 1.24 to reestablish access from EC2 to OpenSearch for clearing OpenSearch indexes.