chore: Backport mySQL version warning to currently supported Enterprise docs#1098
chore: Backport mySQL version warning to currently supported Enterprise docs#1098justinegeffen wants to merge 7 commits intomasterfrom
Conversation
justinegeffen
added
1. Dev/PM/SME
✅ Deploy Preview for seqera-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
✅ Editorial Review Complete (PR type: content) - No issues found! Documentation looks good. Review by Claude Code editorial agents |
📝 Documentation Review Summary (PR type: content)
Review powered by Claude Code editorial agents To apply suggestions:
|
justinegeffen
changed the title
bebosudo
left a comment
bebosudo
left a comment
There was a problem hiding this comment.
Thanks for this. Here are some comments
platform-enterprise_versioned_docs/version-25.1/enterprise/install-platform.md
Outdated
Show resolved
Hide resolved
platform-enterprise_versioned_docs/version-25.1/enterprise/overview.md
Outdated
Show resolved
Hide resolved
…tall-platform.md Co-authored-by: Alberto Chiusole <1922124+bebosudo@users.noreply.github.com> Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
…rview.md Co-authored-by: Alberto Chiusole <1922124+bebosudo@users.noreply.github.com> Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
This comment was marked as resolved.
This comment was marked as resolved.
📝 Documentation Review Summary (PR type: content)
Review powered by Claude Code editorial agents To apply suggestions:
|
|
✅ Editorial Review Complete (PR type: content) - No issues found! Documentation looks good. Review by Claude Code editorial agents |
📝 Documentation Review Summary (PR type: content)
Review powered by Claude Code editorial agents To apply suggestions:
|
bebosudo
left a comment
bebosudo
left a comment
There was a problem hiding this comment.
In the v25.x docs I'd remove all :::note sections about MySQL, and just state v8 is required, v5.x is not supported.
platform-enterprise_versioned_docs/version-25.1/enterprise/configuration/overview.mdx
Show resolved
Hide resolved
| - AWS Aurora MySQL (standard provisioned instances, not Serverless) | ||
| - Self-managed MySQL 8.0 | ||
|
|
||
| If you are currently using Aurora Serverless and experiencing performance issues, we strongly recommend migrating to one of the supported database configurations above. |
There was a problem hiding this comment.
do we need to mention the caveats with AWS here?
I'd rewrite this to say that MySQL v8 is needed
Also, do we want to mention self-managing it as an option @gavinelder?
There was a problem hiding this comment.
Honestly I would write something like the following.
### Database requirements
:::warning
**Elastically provisioned databases not recommended**
Seqera Enterprise database demand varies significantly based on pipeline workloads. Elastically provisioned database services (such as AWS Aurora Serverless) are not recommended for production deployments, as they may experience stability and performance issues under typical workload patterns.
For production use, we recommend a provisioned database:
- **AWS RDS**: MySQL 8.0+
- **Azure Database**: MySQL 8.0+
- **Google Cloud SQL**: MySQL 8.0+
- Self-managed databases with appropriate resource allocation
If you're currently using an elastically provisioned database and experiencing issues, we recommend migrating to one of the configurations above.
:::
:::warning
**Breaking change in version 23.4**: MySQL 8 is now required. If you are currently using MySQL 5.6 or 5.7, you must upgrade your database to MySQL 8.0 before upgrading to version 23.4 or later.
:::
Aurora Serverless will work and it is something we test compatibility for and use in lower environments as it offers us a good cost to performance option for PR previews however for certain workloads which have a large volume of task events being submitted around the same time this may cause a demand on the database which services cannot scale for in-time resulting in increased latency and performance issues.
If a team has a skill and capacity to properly scale and set resource definitions on Aurora Serverless then it is an suitable system for them to use, however the cost to performance ratio may no longer make sense.
The item we're trying to avoid here , is end-users having no activity on the database over a weekend , Aurora scaling down then when there is a spike in pipeline runs having a performance degradation, as the database allocated capacity fails to meet demand.
platform-enterprise_versioned_docs/version-25.1/enterprise/configuration/overview.mdx
Outdated
Show resolved
Hide resolved
…figuration/overview.mdx Co-authored-by: Alberto Chiusole <1922124+bebosudo@users.noreply.github.com> Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
|
✅ Editorial Review Complete (PR type: content) - No issues found! Documentation looks good. Review by Claude Code editorial agents |
📝 Documentation Review Summary (PR type: content)
Review powered by Claude Code editorial agents To apply suggestions:
|
gavinelder
left a comment
gavinelder
left a comment
There was a problem hiding this comment.
I would prefer to ship this backport and alignment of the content accross versions seperately from doing a content review.
There is two distinct items here.
- Enable Consistency - Which this PR does.
- Educate and affirm customer choices.
The reality is that this information in older documentation is not that valuable.
Customers install once and then move on with operations , updating an older documentation set with improved installation instructions is great however In most cases customers will be looking at latest.
As such lets try and be a bit more aggressive in pushing out corrections and clarifications but lets not worry too much about specific wording as the likelihood it's actually going to be looked at is low.
We can do major improvements for 26.1
Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
3 participants
Follow up on #1076