You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The tyk-docs repository has had a PR raised that proposes a config description update for CertificatesConfig.Upstream within the autogenerated Gateway config file from source. This PR has been created on behalf of @matthewdickinson with proposed change for review. Once reviewed and if approved, the fix would need to be synced into docs repository.
Related Issue
Motivation and Context
How This Has Been Tested
Screenshots (if appropriate)
Types of changes
Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Refactoring or add test (improvements in base code or adds test coverage to functionality)
Checklist
I ensured that the documentation is up to date
I explained why this PR updates go.mod in detail with reasoning why it's required
I would like a code coverage CI quality gate exception and have explained why
Type
documentation
Description
Updated the CertificatesConfig.Upstream documentation in config/config.go to improve clarity on how to specify upstream mutual TLS certificates globally. This includes a more detailed description and examples for both tyk.conf and environmental variable configurations.
Changes walkthrough
Relevant files
Documentation
config.go
Update Documentation for Upstream Mutual TLS Certificates Configuration
config/config.go
Updated the description for CertificatesConfig.Upstream to clarify the format and usage of upstream mutual TLS certificates.
Provided examples for configuring CertificatesConfig.Upstream in tyk.conf and as an environmental variable.
--- prev.txt 2024-03-20 13:19:39.598276933 +0000+++ current.txt 2024-03-20 13:19:36.710283116 +0000@@ -4762,7 +4762,9 @@
type CertificatesConfig struct {
API []string `json:"apis"`
- // Specify upstream mutual TLS certificates at a global level in the following format: `{ "<host>": "<cert>" }``+ // Specify upstream mutual TLS certificates at a global level as a map of domain -> certificate id or path+ // In tyk.conf, this would be `"security": {"certificates": {"upstream": {"*": "/certs/default.pem", "example.com": "ab23ef123"}}},`; as an environmental variable it would be+ // `*:/certs/default.pem,example.com:ab23ef123`.
Upstream map[string]string `json:"upstream"`
// Certificates used for Control API Mutual TLS
ControlAPI []string `json:"control_api"`
1, because the PR involves a straightforward documentation update within the code. It updates comments to provide clearer instructions on how to configure upstream mutual TLS certificates. The change is limited to comments and does not affect the functionality of the code, making it a quick and easy review.
🧪 Relevant tests
No
🔍 Possible issues
No
🔒 Security concerns
No
Code feedback:
relevant file
config/config.go
suggestion
Consider adding examples for more complex configurations if applicable. This could help users understand how to handle scenarios with multiple certificates or more intricate setups. [medium]
Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:
The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.
Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.
Examples for extra instructions:
[pr_reviewer] # /review #
extra_instructions="""
In the 'possible issues' section, emphasize the following:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
How to enable\disable automation
When you first install PR-Agent app, the default mode for the review tool is:
pr_commands = ["/review", ...]
meaning the review tool will run automatically on every PR, with the default configuration.
Edit this field to enable/disable the tool, or to change the used configurations
Auto-labels
The review tool can auto-generate two specific types of labels for a PR:
a possible security issue label, that detects possible security issues (enable_review_labels_security flag)
a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)
Extra sub-tools
The review tool provides a collection of possible feedbacks about a PR.
It is recommended to review the possible options, and choose the ones relevant for your use case.
Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: require_score_review, require_soc2_ticket, require_can_be_split_review, and more.
Auto-approve PRs
By invoking:
/review auto_approve
The tool will automatically approve the PR, and add a comment with the approval.
To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following:
[pr_reviewer]
enable_auto_approval = true
(this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository)
You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag:
[pr_reviewer]
maximal_review_effort = 5
More PR-Agent commands
To invoke the PR-Agent, add a comment using one of the following commands:
/review: Request a review of your Pull Request.
/describe: Update the PR title and description based on the contents of the PR.
Break down the long comment into multiple lines for better readability.
Consider breaking down the long comment into multiple lines to adhere to Go's convention of keeping line lengths reasonable, typically under 100 characters. This improves readability and maintainability of the code.
-// Specify upstream mutual TLS certificates at a global level as a map of domain -> certificate id or path-// In tyk.conf, this would be `"security": {"certificates": {"upstream": {"*": "/certs/default.pem", "example.com": "ab23ef123"}}},`; as an environmental variable it would be+// Specify upstream mutual TLS certificates at a global level as a map of domain -> certificate id or path.+// In tyk.conf, this configuration looks like:+// `"security": {"certificates": {"upstream": {"*": "/certs/default.pem", "example.com": "ab23ef123"}}},`+// As an environmental variable, it is represented as:
// `*:/certs/default.pem,example.com:ab23ef123`.
✨ Improve tool usage guide:
Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:
meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.
Utilizing extra instructions
Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project.
Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on.
Examples for extra instructions:
[pr_code_suggestions] # /improve #
extra_instructions="""
Emphasize the following aspects:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
A note on code suggestions quality
While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base.
Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool
With large PRs, best quality will be obtained by using 'improve --extended' mode.
More PR-Agent commands
To invoke the PR-Agent, add a comment using one of the following commands:
/review: Request a review of your Pull Request.
/describe: Update the PR title and description based on the contents of the PR.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
Description
The tyk-docs repository has had a PR raised that proposes a config description update for CertificatesConfig.Upstream within the autogenerated Gateway config file from source. This PR has been created on behalf of @matthewdickinson with proposed change for review. Once reviewed and if approved, the fix would need to be synced into docs repository.
Related Issue
Motivation and Context
How This Has Been Tested
Screenshots (if appropriate)
Types of changes
Checklist
Type
documentation
Description
CertificatesConfig.Upstreamdocumentation inconfig/config.goto improve clarity on how to specify upstream mutual TLS certificates globally. This includes a more detailed description and examples for bothtyk.confand environmental variable configurations.Changes walkthrough
config.go
Update Documentation for Upstream Mutual TLS CertificatesConfigurationconfig/config.go
CertificatesConfig.Upstreamto clarify theformat and usage of upstream mutual TLS certificates.
CertificatesConfig.Upstreamintyk.confand as an environmental variable.