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

[DX-1379] Fix mongo chart version #4677

Merged
merged 1 commit into from
Jun 1, 2024
Merged

[DX-1379] Fix mongo chart version #4677

merged 1 commit into from
Jun 1, 2024

Conversation

komalsukhani
Copy link
Contributor

@komalsukhani komalsukhani commented May 24, 2024

User description

For internal users - Please add a Jira DX PR ticket to the subject!


Change mongo bitnami chart version from 15.1.2 to 15.1.3, as 15.1.2 is not available anymore.


Preview Link


Description


Screenshots (if appropriate)


Checklist

  • I have added a preview link to the PR description.
  • I have reviewed the guidelines for contributing to this repository.
  • I have read the technical guidelines for contributing to this repository.
  • Make sure you have started your change off our latest master.
  • I labelled the PR

PR Type

Documentation


Description

  • Updated MongoDB Bitnami chart version from 15.1.2 to 15.1.3 across multiple documentation files.
  • Ensured consistency in MongoDB installation instructions in various Tyk charts and deployment guides.

Changes walkthrough 📝

Relevant files
Documentation
tyk-helm-tyk-stack-mongodb.md
Update MongoDB Bitnami chart version in Kubernetes installation guide

tyk-docs/content/deployment-and-operations/tyk-self-managed/deployment-lifecycle/installations/kubernetes/tyk-helm-tyk-stack-mongodb.md

  • Updated MongoDB Bitnami chart version from 15.1.2 to 15.1.3.
+1/-1     
tyk-control-plane-chart.md
Update MongoDB Bitnami chart version in Tyk Control Plane chart

tyk-docs/content/product-stack/tyk-charts/tyk-control-plane-chart.md

  • Updated MongoDB Bitnami chart version from 15.1.2 to 15.1.3.
+1/-1     
tyk-oss-chart.md
Update MongoDB Bitnami chart version in Tyk OSS chart       

tyk-docs/content/product-stack/tyk-charts/tyk-oss-chart.md

  • Updated MongoDB Bitnami chart version from 15.1.2 to 15.1.3.
+1/-1     
tyk-stack-chart.md
Update MongoDB Bitnami chart version in Tyk Stack chart   

tyk-docs/content/product-stack/tyk-charts/tyk-stack-chart.md

  • Updated MongoDB Bitnami chart version from 15.1.2 to 15.1.3.
+1/-1     
tyk-helm-chart.md
Update MongoDB Bitnami chart version in Tyk Helm chart     

tyk-docs/content/tyk-self-managed/tyk-helm-chart.md

  • Updated MongoDB Bitnami chart version from 15.1.2 to 15.1.3.
+1/-1     

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

Copy link

netlify bot commented May 24, 2024

PS. Pls add /docs/nightly to the end of url

Name Link
🔨 Latest commit 33f7a99
🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/6650941375b85200088e8475
😎 Deploy Preview https://deploy-preview-4677--tyk-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented May 24, 2024

PS. Pls add /docs/nightly to the end of url

Name Link
🔨 Latest commit 2edf224
🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/665b9c735527180008096ccb
😎 Deploy Preview https://deploy-preview-4677--tyk-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@komalsukhani komalsukhani marked this pull request as ready for review May 24, 2024 14:04
Copy link
Contributor

PR Description updated to latest commit (33f7a99)

Copy link
Contributor

PR Review 🔍

⏱️ Estimated effort to review [1-5]

1, because the PR involves a simple version update in multiple documentation files. The changes are straightforward and only involve updating the version number of a dependency.

🧪 Relevant tests

No

⚡ Possible issues

No

🔒 Security concerns

No

Code feedback:

Copy link
Contributor

PR Code Suggestions ✨

CategorySuggestion                                                                                                                                    Score
Maintainability
Use a variable for MongoDB version to ensure consistency and ease maintenance

Consider using a variable for the MongoDB version to ensure consistency across all
documentation and to simplify future updates. This can help avoid discrepancies and reduce
the maintenance overhead when version numbers change.

tyk-docs/content/deployment-and-operations/tyk-self-managed/deployment-lifecycle/installations/kubernetes/tyk-helm-tyk-stack-mongodb.md [36]

-MONGO_BITNAMI_CHART_VERSION=15.1.3
+MONGO_BITNAMI_CHART_VERSION=$MONGO_VERSION
 
Suggestion importance[1-10]: 8

Why: Using a variable for the MongoDB version improves maintainability and consistency across the documentation, making future updates easier and reducing the risk of discrepancies.

8
Abstract MongoDB installation command into a script for easier updates and maintenance

To ensure that the MongoDB installation command is easily updatable and error-free,
consider abstracting the entire helm command into a script or a makefile target.

tyk-docs/content/product-stack/tyk-charts/tyk-oss-chart.md [395]

-helm install tyk-mongo bitnami/mongodb --set "replicaSet.enabled=true" -n tyk --version 15.1.3
+./deploy_mongo.sh
 
Suggestion importance[1-10]: 6

Why: Abstracting the command into a script or makefile target can improve maintainability and reduce errors, but it may add unnecessary complexity for simple documentation.

6
Best practice
Use a variable for the namespace to avoid hardcoding and potential conflicts

To avoid hardcoding the namespace and potentially conflicting with user-specific
configurations, consider using a placeholder or a variable for the namespace.

tyk-docs/content/product-stack/tyk-charts/tyk-control-plane-chart.md [210]

-helm install tyk-mongo bitnami/mongodb --set "replicaSet.enabled=true" -n tyk --version 15.1.3
+helm install tyk-mongo bitnami/mongodb --set "replicaSet.enabled=true" -n $NAMESPACE --version 15.1.3
 
Suggestion importance[1-10]: 7

Why: Using a variable for the namespace avoids hardcoding and potential conflicts with user-specific configurations, which is a good practice for flexibility and maintainability.

7
Enhancement
Add a parameter to toggle MongoDB replica sets for flexibility

To ensure future-proofing and flexibility, consider adding a parameter to enable or
disable replica sets based on user needs, rather than setting it directly in the command.

tyk-docs/content/product-stack/tyk-charts/tyk-stack-chart.md [210]

-helm install tyk-mongo bitnami/mongodb --set "replicaSet.enabled=true" -n tyk --version 15.1.3
+helm install tyk-mongo bitnami/mongodb --set "replicaSet.enabled=$REPLICA_SET_ENABLED" -n tyk --version 15.1.3
 
Suggestion importance[1-10]: 7

Why: Adding a parameter for enabling or disabling replica sets increases flexibility and future-proofs the command, making it adaptable to different user needs.

7

@dcs3spp dcs3spp changed the title Fix mongo chart version [DX-1379] Fix mongo chart version May 24, 2024
@letzya letzya enabled auto-merge (squash) May 28, 2024 09:36
Copy link
Contributor

@dcs3spp dcs3spp left a comment

Choose a reason for hiding this comment

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

@komalsukhani PR LGTM, before merging and release requires peer approval and labelling the PR with the release this is intended for.

@letzya
Copy link
Collaborator

letzya commented May 31, 2024

ship it?

@letzya letzya merged commit 547ea39 into master Jun 1, 2024
10 checks passed
@letzya letzya deleted the fix-mongo-chart-version branch June 1, 2024 22:12
@dcs3spp
Copy link
Contributor

dcs3spp commented Jun 3, 2024

/release to release-5.3

Copy link

tykbot bot commented Jun 3, 2024

Working on it! Note that it can take a few minutes.

tykbot bot pushed a commit that referenced this pull request Jun 3, 2024
Fix mongo chart version

(cherry picked from commit 547ea39)
Copy link

tykbot bot commented Jun 3, 2024

@dcs3spp Succesfully merged PR

buger added a commit that referenced this pull request Jun 3, 2024
[DX-1379] Fix mongo chart version (#4677)

Fix mongo chart version
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants