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

Fix Helm Command #5855

Merged
merged 1 commit into from
Dec 31, 2024
Merged

Fix Helm Command #5855

merged 1 commit into from
Dec 31, 2024

Conversation

sharadregoti
Copy link
Contributor

@sharadregoti sharadregoti commented Dec 31, 2024

User description

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



Preview Link


Description


Screenshots (if appropriate)


Checklist

  • I have added a preview link to the PR description.
  • I have reviewed the suggestions made by our AI (PR Agent) and updated them accordingly (spelling errors, rephrasing, etc.)
  • 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 labeled the PR

PR Type

documentation


Description

  • Added the helm repo add bitnami https://charts.bitnami.com/bitnami command to the MongoDB installation instructions to ensure the Bitnami repository is added before installation.
  • Added the helm repo add bitnami https://charts.bitnami.com/bitnami command to the PostgreSQL installation instructions to ensure the Bitnami repository is added before installation.
  • These changes improve the clarity and completeness of the installation documentation for Tyk Stack Charts.

Changes walkthrough 📝

Relevant files
Documentation
tyk-stack-chart.md
Added missing Helm repository commands for MongoDB and PostgreSQL

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

  • Added a command to add the Bitnami Helm repository before MongoDB
    installation instructions.
  • Added a command to add the Bitnami Helm repository before PostgreSQL
    installation instructions.
  • +2/-0     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Redundant Helm Command

    The helm repo add bitnami https://charts.bitnami.com/bitnami command is added twice, once for MongoDB installation and once for PostgreSQL installation. Consider consolidating this command to avoid redundancy.

    helm repo add bitnami https://charts.bitnami.com/bitnami
    helm install tyk-mongo bitnami/mongodb --set "replicaSet.enabled=true" -n tyk --version 15.1.3

    {{< note success >}}
    Note

    Bitnami MongoDB image is not supported on darwin/arm64 architecture.
    {{< /note >}}

    Then follow notes from the installation output to get connection details and update them in values.yaml file.

    {{< note success >}}
    Note

    Please make sure you are installing MongoDB versions that are supported by Tyk. Please refer to Tyk docs to get list of [supported versions]({{< ref "tyk-dashboard/database-options" >}}).
    {{< /note >}}

    {{< note success >}}
    Note

    Important Note regarding MongoDB:

    This helm chart enables the PodDisruptionBudget for MongoDB with an arbiter replica-count of 1. If you intend to perform system maintenance on the node where the MongoDB pod is running and this maintenance requires the node to be drained, then this action will be prevented due to the the replica count being 1.

    Increase the replica count in the helm chart deployment to a minimum of 2 to remedy this issue.
    {{< /note >}}

    Configure global.mongo.mongoURL and global.storageType as below. You should replace password in the connection string with the MONGODB_ROOT_PASSWORD you obtain from the installation output notes.

    global:
      # Set mongo connection details if you want to configure mongo pump.
      mongo:
        # The mongoURL value will allow you to set your MongoDB address.
        # Default value: mongodb://mongo.{{ .Release.Namespace }}.svc:27017/tyk_analytics
        # mongoURL: mongodb://mongo.tyk.svc:27017/tyk_analytics
    
        # If your MongoDB has a password you can add the username and password to the url
        mongoURL: mongodb://root:[email protected]:27017/tyk_analytics?authSource=admin
    
        # mongo-go driver is supported for Tyk 5.0.2+.
        # We recommend using the mongo-go driver if you are using MongoDB 4.4.x+.
        # For MongoDB versions prior to 4.4, please use the mgo driver.
        # Since Tyk 5.3 the default driver is mongo-go.
        driver: mongo-go
    
        # Connection URL can also be set using a secret. Provide the name of the secret and key below.
        # connectionURLSecret:
        #   name: ""
        #   keyName: ""
    
        # Enables SSL for MongoDB connection. MongoDB instance will have to support that.
        # Default value: false
        useSSL: false
    
      # Choose the storageType for Tyk. [ "mongo", "postgres" ]
      storageType: &globalStorageType mongo

    PostgresSQL Installation

    helm repo add bitnami https://charts.bitnami.com/bitnami

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Avoid redundant helm repo add commands to prevent unnecessary repetition and potential confusion

    Ensure the helm repo add bitnami https://charts.bitnami.com/bitnami command is not
    repeated unnecessarily if it has already been executed earlier in the document, as
    this could lead to redundancy and confusion.

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

    -helm repo add bitnami https://charts.bitnami.com/bitnami
    +# Remove this line if the repository has already been added earlier in the document
    Suggestion importance[1-10]: 4

    Why: The suggestion highlights a valid concern about redundancy, which could improve the clarity of the documentation. However, it is not actionable as it merely asks the user to ensure the command is not repeated, without providing a concrete solution or context-specific improvement.

    4

    Copy link

    netlify bot commented Dec 31, 2024

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

    Name Link
    🔨 Latest commit a0a1f11
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/6773aa38b88d1100080c6a91
    😎 Deploy Preview https://deploy-preview-5855--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.

    @sharadregoti sharadregoti merged commit a27145c into master Dec 31, 2024
    9 checks passed
    @sharadregoti sharadregoti deleted the fix-helm branch December 31, 2024 08:28
    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.

    1 participant