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

Fixed Tyk Cloud issues #5892

Merged
merged 1 commit into from
Jan 14, 2025
Merged

Fixed Tyk Cloud issues #5892

merged 1 commit into from
Jan 14, 2025

Conversation

sharadregoti
Copy link
Contributor

@sharadregoti sharadregoti commented Jan 14, 2025

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

  • Updated links in tyk-cloud.md to use anchor-based references.

  • Enhanced formatting and structure in tyk-self-managed.md for better readability.

  • Added missing anchor references in alias.json for improved navigation.

  • Improved consistency in installation instructions and examples.


Changes walkthrough 📝

Relevant files
Documentation
tyk-cloud.md
Updated links and navigation in Tyk Cloud documentation   

tyk-docs/content/tyk-cloud.md

  • Updated links to use anchor-based references.
  • Improved clarity in navigation for configuration and administration
    sections.
  • +5/-5     
    tyk-self-managed.md
    Improved formatting and instructions for Tyk Self-Managed setup

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

  • Enhanced formatting for prerequisites and installation steps.
  • Added indentation and structure for better readability.
  • Included detailed step-by-step instructions for various setups.
  • +207/-169
    alias.json
    Added and updated anchor references in alias.json               

    tyk-docs/data/alias.json

  • Added missing anchor references for monitoring and installation
    sections.
  • Updated existing aliases to point to correct anchors.
  • +8/-8     

    💡 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: 4 🔵🔵🔵🔵⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Broken Links

    Ensure that all updated links in the badges and references point to the correct and existing sections or pages. Some links may have been changed or updated incorrectly.

    {{< badge title="Configuration" href="tyk-cloud#add-custom-authentication" >}}
    
    **Python custom plugins**
    
    Implement your own custom logic with Python based plugins
    {{< /badge >}}
    
    {{< badge title="Configuration" href="tyk-cloud#configure-custom-domains" >}}
    
    **Using custom domains**
    
    Configure custom domain for your Dashboard and Developer Portal
    {{< /badge >}}
    
    {{< badge title="Administration" href="tyk-cloud#managing-environments" >}}
    
    **Manage environments**
    
    Create and manage multiple environments within your Tyk Cloud organization
    {{< /badge >}}
    
    {{< badge title="Administration" href="tyk-cloud#managing-control-planes" >}}
    
    **Manage deployments**
    
    Create and manage your Cloud Control Plane and Cloud Data Plane deployments
    {{< /badge >}}
    
    {{< badge title="Administration" href="tyk-cloud#managing-teams-and-users" >}}
    
    **Manage teams & users**
    
    Create teams in your organization, define roles and manage user access
    {{< /badge >}}
    
    {{< badge title="Account" href="tyk-cloud#manage-accounts-and-billing" >}}
    
    Formatting Consistency

    The new formatting for prerequisites and installation steps introduces additional spacing and indentation. Ensure this does not disrupt the readability or rendering of the documentation.

    The helm chart `tyk-helm/tyk-pro` will install full Tyk platform with **Tyk Manager**, **Tyk Gateways** and **Tyk Pump** into your Kubernetes cluster. You can also choose to enable the installation of **Tyk Operator** (to manage your APIs in a declarative way).
    
    **Prerequisites**
    
    1. **Tyk License**
    
        If you are evaluating Tyk on Kubernetes, [contact us](https://tyk.io/about/contact/) to obtain a temporary license.
    
    2. **Data stores**
    
        The following are required for a Tyk Self-Managed installation:
        - Redis   - Should be installed in the cluster or reachable from inside the cluster (for SaaS option).
                    You can find instructions for a simple Redis installation bellow.
        - MongoDB or SQL - Should be installed in the cluster or be reachable by the **Tyk Manager** (for SaaS option).
    
        You can find supported MongoDB and SQL versions [here]({{< ref "#database-management" >}}).
    
        Installation instructions for Redis and MongoDB/SQL are detailed below.
    
    3. **Helm**
    
        Installed [Helm 3](https://helm.sh/)
        Tyk Helm Chart is using Helm v3 version (i.e. not Helm v2).
    
    **Installation**
    
    As well as our official Helm repo, you can also find it in [ArtifactHub](https://artifacthub.io/packages/helm/tyk-helm/tyk-pro).
    <div class="artifacthub-widget" data-url="https://artifacthub.io/packages/helm/tyk-helm/tyk-pro" data-theme="light" data-header="true" data-responsive="true"><blockquote><p lang="en" dir="ltr"><b>tyk-pro</b>: This chart deploys our full Tyk platform. The Tyk Gateway is a fully open source Enterprise API Gateway, supporting REST, GraphQL, TCP and gRPC protocols. The Tyk Gateway is provided ‘Batteries-included’, with no feature lockout. It enables organizations and businesses around the world to protect, secure, and process APIs and well as review and audit the consumed apis.</p>&mdash; Open in <a href="https://artifacthub.io/packages/helm/tyk-helm/tyk-pro">Artifact Hub</a></blockquote></div><script async src="https://artifacthub.io/artifacthub-widget.js"></script>
    
    If you are interested in contributing to our charts, suggesting changes, creating PRs or any other way,
    please use [GitHub Tyk-helm-chart repo](https://github.com/TykTechnologies/tyk-helm-chart/tree/master/tyk-pro)
    or contact us in [Tyk Community forum](https://community.tyk.io/) or through our sales team.
    
    
    1. **Add Tyk official Helm repo to your local Helm repository**
    
        ```bash
        helm repo add tyk-helm https://helm.tyk.io/public/helm/charts/
        helm repo update
        ```
    
    2. **Create namespace for your Tyk deployment**
    
        ```bash
        kubectl create namespace tyk
        ```
    
    3. **Getting the values.yaml of the chart**
    
        Before we proceed with installation of the chart you need to set some custom values.
        To see what options are configurable on a chart and save that options to a custom values.yaml file run:
    
        ```bash
        helm show values tyk-helm/tyk-pro > values.yaml
        ```
    
    **Installing the data stores**
    
    For Redis, MongoDB or SQL you can use these rather excellent charts provided by Bitnami
    
    {{< tabs_start >}}
    {{< tab_start "Redis" >}}
    <br />
    
    **Redis**
    ```bash
    helm install tyk-redis bitnami/redis -n tyk --version 19.0.2

    {{< note success >}}
    Note

    Please make sure you are installing Redis versions that are supported by Tyk. Please refer to Tyk docs to get list of [supported versions]({{< ref "#redis-1" >}}).
    {{< /note >}}

    Follow the notes from the installation output to get connection details and password.

      Redis(TM) can be accessed on the following DNS names from within your cluster:
    
        tyk-redis-master.tyk.svc.cluster.local for read/write operations (port 6379)
        tyk-redis-replicas.tyk.svc.cluster.local for read-only operations (port 6379)
    
      export REDIS_PASSWORD=$(kubectl get secret --namespace tyk tyk-redis -o jsonpath="{.data.redis-password}" | base64 --decode)

    The DNS name of your Redis as set by Bitnami is tyk-redis-master.tyk.svc.cluster.local:6379 (Tyk needs the name including the port)
    You can update them in your local values.yaml file under redis.addrs and redis.pass
    Alternatively, you can use --set flag to set it in Tyk installation. For example --set redis.pass=$REDIS_PASSWORD
    {{< tab_end >}}
    {{< tab_start "MongoDB" >}}

    MongoDB

    helm install tyk-mongo bitnami/mongodb --set "replicaSet.enabled=true" -n tyk --version 15.1.3

    {{< note success >}}
    Note

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

    Follow the notes from the installation output to get connection details and password. The DNS name of your MongoDB as set with Bitnami is tyk-mongo-mongodb.tyk.svc.cluster.local and you also need to set the authSource parameter to admin. The full mongoURL should be similar to mongoURL: mongodb://root:[email protected]:27017/tyk_analytics?authSource=admin. You can update them in your local values.yaml file under mongo.mongoURL Alternatively, you can use --set flag to set it in your Tyk installation.

    {{< note success >}}
    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 for the node to be drained,
    this action will be prevented due the replica count being 1. Increase the replica count in the helm chart deployment to
    a minimum of 2 to remedy this issue.

    {{< /note >}}

    {{< tab_end >}}
    {{< tab_start "SQL" >}}

    Postgres

    helm install tyk-postgres bitnami/postgresql --set "auth.database=tyk_analytics" -n tyk --version 12.12.10

    {{< note success >}}
    Note

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

    Follow the notes from the installation output to get connection details and password. The DNS name of your Postgres service as set by Bitnami is tyk-postgres-postgresql.tyk.svc.cluster.local.
    You can update connection details in values.yaml file under postgres.
    {{< tab_end >}}
    {{< tabs_end >}}


    Quick Redis and MongoDB PoC installation
    {{< warning success >}}
    Warning

    Another option for Redis and MongoDB, to get started quickly, is to use our simple-redis and simple-mongodb charts.
    Please note that these provided charts must not ever be used in production and for anything
    but a quick start evaluation only. Use external redis or Official Redis Helm chart in any other case.
    We provide this chart, so you can quickly get up and running, however it is not meant for long term storage of data for example.

    helm install redis tyk-helm/simple-redis -n tyk
    helm install mongo tyk-helm/simple-mongodb -n tyk

    {{< /warning >}}

    License setting

    For the Tyk Self-Managed chart we need to set the license key in your custom values.yaml file under dash.license field
    or use --set dash.license={YOUR-LICENSE_KEY} with the helm install command.

    Tyk Self-Managed licensing allow for different numbers of Gateway nodes to connect to a single Dashboard instance.
    To ensure that your Gateway pods will not scale beyond your license allowance, please ensure that the Gateway's resource kind is Deployment
    and the replica count to your license node limit. By default, the chart is configured to work with a single node license: gateway.kind=Deployment and gateway.replicaCount=1.

    {{< note success >}}
    Please Note

    There may be intermittent issues on the new pods during the rolling update process, when the total number of online
    gateway pods is more than the license limit with lower amounts of Licensed nodes.

    {{< /note >}}

    Installing Tyk Self managed

    Now we can install the chart using our custom values:

    helm install tyk-pro tyk-helm/tyk-pro -f ./values.yaml -n tyk --wait

    {{< note success >}}
    Important Note regarding MongoDB

    The --wait argument is important to successfully complete the bootstrap of your Tyk Manager.

    {{< /note >}}

    Pump Installation

    By default pump installation is disabled. You can enable it by setting pump.enabled to true in values.yaml file.
    Alternatively, you can use --set pump.enabled=true while doing helm install.

    Quick Pump configuration(Supported from tyk helm v0.10.0)

    1. Mongo Pump

    To configure mongo pump, do following changings in values.yaml file:

    1. Set backend to mongo.
    2. Set connection string in mongo.mongoURL.

    2. Postgres Pump

    To configure postgres pump, do following changings in values.yaml file:

    1. Set backend to postgres.
    2. Set connection string parameters in postgres section.

    Tyk Developer Portal

    You can disable the bootstrapping of the Developer Portal by the portal.bootstrap: false in your local values.yaml file.

    Using TLS

    You can turn on the TLS option under the gateway section in your local values.yaml file which will make your Gateway
    listen on port 443 and load up a dummy certificate. You can set your own default certificate by replacing the file in the certs/ folder.

    Mounting Files

    To mount files to any of the Tyk stack components, add the following to the mounts array in the section of that component.
    For example:

    - name: aws-mongo-ssl-cert
     filename: rds-combined-ca-bundle.pem
     mountPath: /etc/certs

    Sharding APIs

    Sharding is the ability for you to decide which of your APIs are loaded on which of your Tyk Gateways. This option is
    turned off by default, however, you can turn it on by updating the gateway.sharding.enabled option. Once you do that you
    will also need to set the gateway.sharding.tags field with the tags that you want that particular Gateway to load. (ex. tags: "external,ingress".)
    You can then add those tags to your APIs in the API Designer, under the Advanced Options tab, and
    the Segment Tags (Node Segmentation) section in your Tyk Dashboard.
    Check [Tyk Gateway Sharding]({{< ref "/content/advanced-configuration/manage-multiple-environments.md#api-sharding" >}}) for more details.

    Install More Tyk Components

    Installing Tyk Enterprise Developer Portal

    If you are deploying the Tyk Enterprise Developer Portal, set the appropriate values under the enterprisePortal section in your values.yaml. Please visit [Tyk Enterprise Developer Portal installation]({{< ref "product-stack/tyk-enterprise-developer-portal/deploy/install-tyk-enterprise-portal/install-portal-using-helm" >}}) for a step by step guide.

    Note: Helm chart supports Enterprise Portal v1.2.0+

    Installing Tyk Self-managed Control Plane

    If you are deploying the Tyk Control plane, a.k.a MDCB, for a Tyk Multi Data Center Bridge deployment then you set
    the mdcb.enabled: true option in the local values.yaml to add of the MDCB component to your installation.
    Check [Tyk Control plane]({{< ref "tyk-multi-data-centre" >}}) for more configuration details.

    This setting enables multi-cluster, multi Data-Center API management from a single dashboard.

    Tyk Identity Broker (TIB)

    The Tyk Identity Broker (TIB) is a micro-service portal that provides a bridge between various Identity Management Systems
    such as LDAP, OpenID Connect providers and legacy Basic Authentication providers, to your Tyk installation.
    See [TIB]({{< ref "tyk-identity-broker/getting-started" >}}) for more details.

    For SSO to Tyk Manager and Tyk developer portal purposes you do not need to install TIB, as its functionality is now
    part of the Tyk Manager. However, if you want to run it separately (as you used to before this merge) or if you need it
    as a broker for the Tyk Gateway you can do so.

    Once you have installed your Tyk Gateway and Tyk Manager, you can configure TIB by adding its configuration environment variables
    under the tib.extraEnvs section and updating the profile.json in your configs folder.
    See our TIB GitHub repo.
    Once you complete your modifications you can run the following command from the root of the repository to update your helm chart.

    helm upgrade tyk-pro values.yaml -n tyk

    This chart implies there's a ConfigMap with a profiles.json definition in it. Please use tib.configMap.profiles value
    to set the name of this ConfigMap (tyk-tib-profiles-conf by default).

    Tyk Operator and Ingress

    For a GitOps workflow used with a Tyk Self-Managed installation or setting the Tyk Gateway as a Kubernetes ingress controller, Tyk Operator enables you to manage API definitions, security policies and other Tyk features using Kubernetes manifest files.
    To get started go to [Tyk Operator]({{< ref "api-management/automations#automate-api-management-in-kubernetes-environments" >}}).

    Install on AWS Marketplace

    Tyk offers a flexible and powerful API management solution through Tyk Cloud on the AWS Marketplace. Tyk Cloud is an end-to-end managed API platform where both the control plane and gateways are installed on AWS for a seamless, fully cloud-hosted experience.

    For those who need more deployment flexibility, Tyk Cloud also supports a [Hybrid Gateway]({{< ref "tyk-cloud#deploy-hybrid-gateways" >}}) option. In this setup, the control plane remains hosted and managed by Tyk on AWS, while the gateways can be deployed on your preferred cloud provider or on-premises environment—allowing you to meet data locality and compliance needs without sacrificing control.

    Available AWS Deployment Regions

    You can deploy Tyk Cloud in the following AWS regions:

    • Singapore: aws-ap-southeast-1
    • Frankfurt, Germany: aws-eu-central-1
    • London, UK: aws-eu-west-2
    • N. Virginia, USA: aws-us-east-1
    • Oregon, USA: aws-us-west-2
    • Australia: aws-ap-southeast-2

    Getting started with Tyk Cloud via the AWS Marketplace is quick and easy. Sign up today to access Tyk’s comprehensive API management tools designed to scale with your needs.

    Install Tyk on AWS EC2

    1. Spin up an EC2 instance, AWS Linux2 preferably, T2.Medium is fine

      • add a public IP
      • open up SG access to:
        • 3000 for the Tyk Dashboard
        • 8080 for the Tyk Gateway
        • 22 TCP for SSH
    2. SSH into the instance
      ssh -i mykey.pem ec2-user@public-ec2-ip

    3. Install Git, Docker, & Docker Compose
      Feel free to copy paste these

    sudo yum update -y
    sudo yum install git -y
    sudo yum install -y docker
    sudo service docker start
    sudo usermod -aG docker ec2-user
    sudo su
    sudo curl -L "https://github.com/docker/compose/releases/download/1.25.5/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
    sudo chmod +x /usr/local/bin/docker-compose
    sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
    docker ps
    1. Clone the Tyk Pro Docker repo
    git clone https://github.com/TykTechnologies/tyk-pro-docker-demo
    cd tyk-pro-docker-demo/
    1. Add the license key to confs/tyk_analytics.conf into the license_key variable using "vi" or "nano", etc

    This is the most common place to have problems.

    Look for extra spaces between quotes ("") and the license key. It will not work if there are any.

    Inside tyk_analytics.conf, license_key should look something like this, with a real license however:

    "license_key": "eyJhbGciOiJSUzI1NiIsInR5cCI...WQ",

    1. Run the containers via docker-compose
    docker-compose up -d
    1. Visit
    http://<public-ec2-ip>:3000
    

    and fill out the Bootstrap form!
    If you see any page besides the Bootstrap page, you have pasted the license key incorrectly

    Enable SSL for the Gateway & Dashboard

    1. Add the following to confs/tyk.conf
    "policies.policy_connection_string": "https://tyk-dashboard:3000"
    "db_app_conf_options.connection_string": "https://tyk-dashboard:3000"
    "http_server_options": {
      "use_ssl": true,
      "certificates": [
        {
          "domain_name": "*.yoursite.com",
          "cert_file": "./new.cert.cert",
          "key_file": "./new.cert.key"
        }
      ],
      "ssl_insecure_skip_verify": true   ### YOU ONLY NEED THIS IF YOU ARE USING SELF SIGNED CERTS
    }
    1. Add the following to confs/tyk_analytics.conf
    "tyk_api_config.Host": "https://tyk-gateway"
    "http_server_options": {
      "use_ssl": true,
      "certificates": [
        {
          "domain_name": "*.yoursite.com",
          "cert_file": "./new.cert.cert",
          "key_file": "./new.cert.key"
        }
      ]
    }
    1. Generate self-signed Certs: (Or bring your own CA signed)
    openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes
    
    1. Mount your certs to containers through docker-compose.yml
    tyk-dashboard:
        ...
        volumes: 
        - ./cert.pem:/opt/tyk-dashboard/new.cert.cert
        - ./key.pem:/opt/tyk-dashboard/new.cert.key
    tyk-gateway:
        ...
        volumes: 
        - ./cert.pem:/opt/tyk-gateway/new.cert.cert
        - ./key.pem:/opt/tyk-gateway/new.cert.key
    1. Restart your containers with the mounted files
    docker-compose up -d tyk-dashboard tyk-gateway
    
    1. Download the bootstrap script onto EC2 machine
    wget https://raw.githubusercontent.com/sedkis/tyk/master/scripts/bootstrap-ssl.sh
    
    1. Apply execute permissions to file:

    chmod +x bootstrap.sh

    1. Run the bootstrap script

    ./bootstrap.sh localhost

    1. Done! use the generated user and password to log into The Tyk Dashboard

    Install with Ansible

    {{< note >}}
    Requirements

    Ansible is required to run the following commands.
    {{< /note >}}

    Getting Started

    1. clone the tyk-ansible repositry

      $ git clone https://github.com/TykTechnologies/tyk-ansible
    2. cd into the directory

      $ cd tyk-ansible
    3. Run initialisation script to initialise environment

      $ sh scripts/init.sh
    4. Modify hosts.yml file to update ssh variables to your server(s). You can learn more about the hosts file here

    5. Run ansible-playbook to install the following:

      • Redis
      • MongoDB or PostgreSQL
      • Tyk Dashboard
      • Tyk Gateway
      • Tyk Pump
      $ ansible-playbook playbook.yaml -t tyk-pro -t redis -t `mongodb` or `pgsql`

      You can choose to not install Redis, MongoDB or PostgreSQL by removing the -t redis or -t mongodb or -t pgsql However Redis and MongoDB or PostgreSQL are a requirement and need to be installed for the Tyk Pro installation to run.

    {{< note success >}}
    Note

    For a production environment, we recommend that the Gateway, Dashboard and Pump are installed on separate machines. If installing multiple Gateways, you should install each on a separate machine. See [Planning for Production]({{< ref "#planning-for-production" >}}) For more details.
    {{< /note >}}

    Supported Distributions

    Distribution Version Supported
    Amazon Linux 2
    CentOS 8
    CentOS 7
    Debian 10
    Debian 9
    RHEL 8
    RHEL 7
    Ubuntu 21
    Ubuntu 20
    Ubuntu 18
    Ubuntu 16

    Variables

    • vars/tyk.yaml

    | Variable | Default | Comments |

    
    </details>
    
    <details><summary><a href='https://github.com/TykTechnologies/tyk-docs/pull/5892/files#diff-7f966c70966928f25b6b49b653a610145cb5a6ef720966e7425094f22468f763R33-R131'><strong>Alias Updates</strong></a>
    
    Verify that the newly added aliases correctly map to the intended sections and do not overwrite or conflict with existing aliases.</summary>
    
    ```json
    "planning-for-production/monitoring": "#monitor-and-observe-your-setup",
    "planning-for-production/monitoring/tyk-components": "#monitor-and-observe-your-setup",
    "planning-for-production/redis-sizing": "#redis-sizing-guidelines",
    "planning-for-production/redis": "#redis",
    "product-stack/tyk-gateway/middleware/circuit-breaker-tyk-classic": "#using-the-circuit-breaker-middleware-with-tyk-classic-apis",
    "product-stack/tyk-gateway/middleware/circuit-breaker-tyk-oas": "#configuring-the-circuit-breaker-in-the-tyk-oas-api-definition",
    "product-stack/tyk-gateway/middleware/enforced-timeout-tyk-classic": "#using-the-enforced-timeout-middleware-with-tyk-classic-apis",
    "product-stack/tyk-gateway/middleware/enforced-timeout-tyk-oas": "#using-the-enforced-timeout-middleware-with-tyk-oas-apis",
    "tyk-cloud/account-billing": "#manage-accounts-and-billing",
    "tyk-cloud/account-billing/add-payment-method": "#add-payment-methods",
    "tyk-cloud/account-billing/managing-billing-admins": "#managing-billing-admin",
    "tyk-cloud/account-billing/plans": "#select-a-payment-plan",
    "tyk-cloud/account-billing/retirement": "#retire-your-account",
    "tyk-cloud/account-billing/upgrade-free-trial": "#upgrade-your-free-trial",
    "tyk-cloud/configuration-options/using-plugins/api-test": "#test-middleware",
    "tyk-cloud/configuration-options/using-plugins/python-code-bundle": "#create-a-python-code-bundle",
    "tyk-cloud/configuration-options/using-plugins/python-custom-auth": "#add-custom-authentication",
    "tyk-cloud/configuration-options/using-plugins/setup-control-plane": "#setup-control-plane",
    "tyk-cloud/configuration-options/using-plugins/uploading-bundle": "#uploading-your-bundle",
    "tyk-cloud/environments-&-deployments": "#manage-environments-and-deployments",
    "tyk-cloud/environments-&-deployments/managing-apis": "#manage-apis",
    "tyk-cloud/environments-&-deployments/managing-control-planes": "#control-planes",
    "tyk-cloud/environments-&-deployments/managing-environments": "#manage-environments",
    "tyk-cloud/environments-&-deployments/managing-gateways": "#gateways-configuration",
    "tyk-cloud/environments-&-deployments/managing-organisations": "#set-up-your-organisation",
    "tyk-cloud/environments-&-deployments/monitoring-how-it-works": "#tyk-cloud-monitor-metrics",
    "tyk-cloud/environments-&-deployments/monitoring-usage": "#track-usage",
    "tyk-cloud/environments-deployments/hybrid-gateways-helm": "#deploy-legacy-hybrid-gateways",
    "tyk-cloud/environments-deployments/hybrid-gateways": "#deploy-hybrid-gateways",
    "tyk-cloud/getting-started-tyk-cloud/create-account": "#step-1-sign-up-for-tyk-cloud",
    "tyk-cloud/getting-started-tyk-cloud/first-api": "#deploy-and-add-your-first-api",
    "tyk-cloud/getting-started-tyk-cloud/setup-environment": "#configure-environment-and-deployments",
    "tyk-cloud/getting-started-tyk-cloud/setup-org": "#set-up-your-organisation",
    "tyk-cloud/getting-started-tyk-cloud/setup-team": "#create-your-first-team",
    "tyk-cloud/getting-started-tyk-cloud/test-api": "#test-your-api",
    "tyk-cloud/getting-started-tyk-cloud/to-conclude": "#review-your-setup",
    "tyk-cloud/getting-started-tyk-cloud/view-analytics": "#view-analytics",
    "tyk-cloud/securing-your-apis": "#secure-your-apis",
    "tyk-cloud/teams-&-users": "#managing-teams-and-users",
    "tyk-cloud/teams-&-users/managing-teams": "#managing-teams",
    "tyk-cloud/teams-&-users/managing-users": "#managing-users",
    "tyk-cloud/teams-&-users/single-sign-on": "#configure-single-sign-on-sso",
    "tyk-cloud/teams-&-users/user-roles": "#assign-user-roles",
    "tyk-cloud/telemetry": "#tyk-cloud-telemetry",
    "tyk-cloud/telemetry/enable-telemetry": "#enabling-telemetry-in-tyk-cloud",
    "tyk-cloud/troubleshooting-&-support": "#troubleshooting-tyk-cloud",
    "tyk-cloud/troubleshooting-&-support/faqs": "#faqs",
    "tyk-cloud/troubleshooting-&-support/glossary": "#glossary",
    "tyk-cloud/troubleshooting-&-support/tyk-cloud-mdcb-supported-versions": "#tyk-cloud-mdcb-supported-versions",
    "tyk-cloud/using-custom-domains": "#use-custom-domains",
    "tyk-cloud/using-plugins": "#using-plugins",
    "tyk-cloud/what-is-tyk-cloud": "#what-is-tyk-cloud",
    "tyk-configuration-reference/kv-store": "#store-configuration-with-key-value-store",
    "tyk-on-prem/installation/redhat-rhel-centos/analytics-pump": "#install-pump",
    "tyk-on-prem/installation/redhat-rhel-centos/dashboard": "#install-dashboard",
    "tyk-on-prem/installation/redhat-rhel-centos/gateway": "#install-gateway",
    "tyk-on-prem/kubernetes-ingress": "#install-on-kubernetes",
    "tyk-on-prem/kubernetes-on-windows": "#install-tyk-stack-on-windows-with-helm",
    "tyk-on-premises": "#",
    "tyk-on-premises/ansible": "#install-with-ansible",
    "tyk-on-premises/bootstrapper-cli": "#install-using-bootstrap-cli",
    "tyk-on-premises/debian-ubuntu": "#install-tyk-on-debian-or-ubuntu",
    "tyk-on-premises/debian-ubuntu/analytics-pump": "#install-pump-1",
    "tyk-on-premises/debian-ubuntu/dashboard": "#install-dashboard-1",
    "tyk-on-premises/debian-ubuntu/gateway": "#install-gateway-1",
    "tyk-on-premises/docker": "#install-with-docker",
    "tyk-on-premises/google-cloud": "#install-to-google-cloud",
    "tyk-on-premises/installation/on-aws": "#install-on-aws-marketplace",
    "tyk-on-premises/installation/on-heroku": "#install-on-heroku",
    "tyk-on-premises/kubernetes": "#install-on-kubernetes",
    "tyk-on-premises/licensing": "#understand-licensing-and-deployment-models",
    "tyk-on-premises/microsoft-azure": "#install-on-microsoft-azure",
    "tyk-on-premises/on-aws/ec2": "#install-on-aws-marketplace",
    "tyk-on-premises/redhat-rhel-centos": "#install-database",
    "tyk-oss/ce-ansible": "#install-tyk-gateway-with-ansible",
    "tyk-oss/ce-debian-ubuntu": "#install-tyk-gateway-on-ubuntu",
    "tyk-oss/ce-docker": "#install-tyk-gateway-with-docker",
    "tyk-oss/ce-github": "#",
    "tyk-oss/ce-helm-chart-new": "#quick-start-with-helm-chart",
    "tyk-oss/ce-helm-chart": "#configure-legacy-tyk-headless-helm-chart",
    "tyk-oss/ce-kubernetes": "#install-tyk-gateway-with-kubernetes",
    "tyk-oss/ce-redhat-rhel-centos": "#install-tyk-gateway-on-red-hat-rhel-centos",
    "tyk-self-managed/tyk-helm-chart": "#use-legacy-helm-chart",
    "tyk-stack/tyk-gateway/configuration/redis-cluster": "#configure-redis-cluster",
    "tyk-stack/tyk-gateway/configuration/redis-sentinel": "#configure-redis-sentinel",
    "tyk-on-premises/docker/docker-pro-demo": "#docker-compose-setup",
    "debugging-series/debugging-series": "#debugging-series",
    "debugging-series/mongodb-debugging": "#mongodb",
    "developer-support/debugging-series/debugging-selfmanaged": "#tyk-self-managed",
    "frequently-asked-questions/api-definition-url-case-sensitive": "#api-definition-url-case-sensitive",
    "frequently-asked-questions/dashboard-bootstrap-error": "#dashboard-bootstrap-error",
    "frequently-asked-questions/find-policy-id-created-policy": "#how-to-find-the-policy-id-for-a-created-policy",
    "frequently-asked-questions/gateway-detected-0-apis": "#gateway-detected-0-apis",
    "frequently-asked-questions/how-to-connect-to-documentdb": "#how-to-connect-to-documentdb-with-x509-client-cert",
    "frequently-asked-questions/how-to-disable-an-api": "#how-to-disable-an-api",
    "frequently-asked-questions/how-to-setup-cors": "#how-to-setup-cors",
    "frequently-asked-questions/import-existing-keys-tyk": "#how-to-import-existing-keys-into-tyk-ce",
    "frequently-asked-questions/no-token-information-dashboard": "#no-key-information-on-the-dashboard",
    "frequently-asked-questions/redis-persistence-using-containers": "#redis-persistence-using-containers",
    

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Add verification steps to ensure Redis and MongoDB/PostgreSQL services are running after being started

    Ensure that the instructions for starting Redis and MongoDB/PostgreSQL explicitly
    verify that the services are running successfully after starting them, to avoid
    potential misconfigurations or unnoticed failures.

    tyk-docs/content/tyk-self-managed.md [2030-2037]

    -sudo service redis start
    -sudo systemctl start mongod
    -sudo systemctl start postgresql-13
    +sudo service redis start && sudo service redis status
    +sudo systemctl start mongod && sudo systemctl status mongod
    +sudo systemctl start postgresql-13 && sudo systemctl status postgresql-13
    Suggestion importance[1-10]: 8

    Why: Adding verification steps ensures that the services are running successfully, which is critical for the functionality of the Tyk platform. This suggestion directly improves reliability and helps users detect issues early.

    8
    Verify the Tyk Dashboard service status after starting it to ensure it is running correctly

    Add a step to verify the Tyk Dashboard service status after starting it, ensuring it
    is running correctly and avoiding potential unnoticed issues.

    tyk-docs/content/tyk-self-managed.md [2083]

    -sudo service tyk-dashboard start
    +sudo service tyk-dashboard start && sudo service tyk-dashboard status
    Suggestion importance[1-10]: 8

    Why: Verifying the service status ensures that the Tyk Dashboard is running as expected, which is crucial for users to proceed with further configurations. This addition significantly improves the reliability of the setup process.

    8
    Specify permissions and method for creating the repository configuration file to prevent permission issues

    Clarify the instructions for creating the /etc/yum.repos.d/tyk_tyk-dashboard.repo
    file by explicitly stating the required permissions and method to create the file,
    to avoid potential permission issues.

    tyk-docs/content/tyk-self-managed.md [1988-1989]

    -Create a file named `/etc/yum.repos.d/tyk_tyk-dashboard.repo` that contains the repository configuration settings...
    +Use `sudo` to create and edit the file `/etc/yum.repos.d/tyk_tyk-dashboard.repo` with the necessary permissions, e.g., `sudo nano /etc/yum.repos.d/tyk_tyk-dashboard.repo`.
    Suggestion importance[1-10]: 7

    Why: Clarifying the method and permissions for creating the file helps avoid potential permission-related errors, improving the usability and accuracy of the documentation.

    7
    Add a step to back up the values.yaml file before making changes to avoid accidental configuration loss

    Include a note to ensure that the values.yaml file is backed up before making
    changes, to prevent accidental loss of existing configurations.

    tyk-docs/content/tyk-self-managed.md [675-676]

    +Before making changes, back up the existing `values.yaml` file if it already exists: `cp values.yaml values.yaml.bak`.
     To see what options are configurable on a chart and save that options to a custom values.yaml file run:
     helm show values tyk-helm/tyk-pro > values.yaml
    Suggestion importance[1-10]: 6

    Why: Including a backup step is a good practice that prevents accidental loss of configurations, enhancing the robustness of the instructions. However, the impact is moderate as it is a precautionary measure.

    6

    Copy link

    netlify bot commented Jan 14, 2025

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

    Name Link
    🔨 Latest commit 320954d
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/678666594c9a640008d4bcf9
    😎 Deploy Preview https://deploy-preview-5892--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 036d4f4 into master Jan 14, 2025
    9 checks passed
    @sharadregoti sharadregoti deleted the tyk-cloud-fixes branch January 14, 2025 13:35
    @sharadregoti
    Copy link
    Contributor Author

    /release to release-5.7

    Copy link

    tykbot bot commented Jan 14, 2025

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

    tykbot bot pushed a commit that referenced this pull request Jan 14, 2025
    (cherry picked from commit 036d4f4)
    Copy link

    tykbot bot commented Jan 14, 2025

    @sharadregoti Succesfully merged PR

    buger added a commit that referenced this pull request Jan 14, 2025
    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