add Best_Practices_for_Using_Pipelines_in_AI_Scenarios.md #76
Conversation
WalkthroughAdds a new, detailed Markdown guide describing best practices for orchestrating Tekton-based pipelines in AI scenarios: GitLab-triggered EventListeners, RoleBinding/ClusterRoleBinding, external EventListener exposure, Trigger/Interceptor/TriggerBinding usage, webhook secret handling, downstream triggering approaches, and Pipeline-as-Code (PAC) setup and examples (≤50 words). Changes
Sequence Diagram(s)sequenceDiagram
participant GitLab as GitLab
participant EL as EventListener
participant IF as Interceptor
participant TB as TriggerBinding
participant Ctrl as Tekton Controller
participant PR as PipelineRun
rect rgb(240,248,255)
GitLab->>EL: Send push webhook
end
rect rgb(255,250,240)
EL->>IF: Forward payload to interceptor
IF->>IF: Validate signature / filter event
IF-->>EL: Emit filtered params
end
rect rgb(240,255,240)
EL->>TB: Apply TriggerBinding (extract & map params)
TB-->>EL: Bound template values
EL->>Ctrl: Create PipelineRun resource
Ctrl->>PR: Instantiate and start pipeline
PR-->>PR: Execute tasks & report status
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20–30 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/en/solutions/Best_Practices_for_Using_Pipelines_in_AI_Scenarios.md (2)
176-176: Reduce phrasing repetition in method introduction.The phrase "need to be introduced" appears to be used in nearby context, making the sentence feel repetitive. Rephrase for variety.
Consider rephrasing Line 176 from:
-To understand this method, some basic concepts of Tekton need to be introduced: +To understand this method, review these core Tekton concepts:
148-148: Replace placeholder ellipsis with example or guidance.Line 148 contains
......as a placeholder for the base64-encoded secret value. While acceptable in documentation, consider adding a brief example or link to encoding instructions to improve usability.Example improvement:
data: webhook.secret: ...... # Base64 encoded secret value + # Example: echo -n 'your-secret' | base64
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/en/solutions/Best_Practices_for_Using_Pipelines_in_AI_Scenarios.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/en/solutions/Best_Practices_for_Using_Pipelines_in_AI_Scenarios.md
[style] ~176-~176: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...s method, some basic concepts of Tekton need to be introduced: - EventListener: An...
(REP_NEED_TO_VB)
🪛 markdownlint-cli2 (0.18.1)
docs/en/solutions/Best_Practices_for_Using_Pipelines_in_AI_Scenarios.md
205-205: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
217-217: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
237-237: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
277-277: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
285-285: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (2)
docs/en/solutions/Best_Practices_for_Using_Pipelines_in_AI_Scenarios.md (2)
376-376: Clarify namespace inconsistency in example configurations.The Repository resource is created in namespace
demo-repo(Line 376), but the Secret example later shows namespacedemo-namespace(Line 399). Clarify whether these resources should be in the same namespace or if this is intentional for your use case.If these resources are meant to be in the same namespace, update Line 399 to:
metadata: name: gitlab-webhook-config - namespace: demo-namespace + namespace: demo-repoAlternatively, add a clarifying note explaining why they differ.
Also applies to: 399-399
1-482: Comprehensive documentation on pipeline orchestration—well structured and thorough.The document provides detailed guidance on three key patterns: EventListener-based GitLab integration, cross-pipeline triggering via custom events, and Pipeline-as-Code. The progression from basic to advanced is logical, and the YAML examples are practical. The use of step-by-step instructions and curl verification commands adds clarity.
Minor notes for future expansion:
- Consider adding troubleshooting tips or common error scenarios.
- Note any prerequisites or version compatibility (e.g., minimum Tekton version, OpenShift vs. vanilla K8s differences).
- Briefly introduce what "Alauda DevOps Pipelines" and "Alauda AI" are for readers unfamiliar with these products.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/en/solutions/Best_Practices_for_Using_Pipelines_in_AI_Scenarios.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/en/solutions/Best_Practices_for_Using_Pipelines_in_AI_Scenarios.md
[style] ~185-~185: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...s method, some basic concepts of Tekton need to be introduced: - EventListener: An...
(REP_NEED_TO_VB)
🪛 markdownlint-cli2 (0.18.1)
docs/en/solutions/Best_Practices_for_Using_Pipelines_in_AI_Scenarios.md
214-214: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
226-226: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
246-246: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
286-286: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
294-294: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
docs/en/solutions/Best_Practices_for_Using_Pipelines_in_AI_Scenarios.md
Outdated
Show resolved
Hide resolved
docs/en/solutions/Best_Practices_for_Using_Pipelines_in_AI_Scenarios.md
Outdated
Show resolved
Hide resolved
docs/en/solutions/Best_Practices_for_Using_Pipelines_in_AI_Scenarios.md
Outdated
Show resolved
Hide resolved
docs/en/solutions/Best_Practices_for_Using_Pipelines_in_AI_Scenarios.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
docs/en/solutions/Best_Practices_for_Using_Pipelines_in_AI_Scenarios.md (1)
214-214: Convert step labels from bold emphasis to markdown headings.These lines still use bold emphasis (
**Step N: ...**) instead of proper markdown heading syntax. This violatesmarkdownlintrule MD036 and degrades document structure. Convert all five step labels to level 3 headings (### Step N: ...) for proper navigation and formatting.Apply this diff to fix all five step label lines:
-**Step 1: Define the Model Training Completion Event** +### Step 1: Define the Model Training Completion Event -**Step 2: Create the Corresponding TriggerBinding** +### Step 2: Create the Corresponding TriggerBinding -**Step 3: Create a Trigger to Use the Custom TriggerBinding** +### Step 3: Create a Trigger to Use the Custom TriggerBinding -**Step 4: Modify the EventListener Configuration** +### Step 4: Modify the EventListener Configuration -**Step 5: Send Events to Trigger Downstream Pipelines** +### Step 5: Send Events to Trigger Downstream PipelinesAlso applies to: 226-226, 246-246, 286-286, 294-294
🧹 Nitpick comments (2)
docs/en/solutions/Best_Practices_for_Using_Pipelines_in_AI_Scenarios.md (2)
419-419: Wrap bare URL in markdown link syntax.Line 419 contains a bare URL, which violates
markdownlintrule MD034. Wrap it in markdown link syntax for proper formatting and accessibility.Apply this diff to fix the bare URL:
-> **Note**: Alternatively, the PAC CLI tool can be used to add repositories. See: https://pipelinesascode.com/docs/guide/cli/#repository-creation +> **Note**: Alternatively, the PAC CLI tool can be used to add repositories. See: [PAC CLI Documentation](https://pipelinesascode.com/docs/guide/cli/#repository-creation)
185-185: Vary repeated phrasing for improved readability.Line 185 reuses "need to be introduced" which appears nearby. Consider a synonym like "need to be explained" or "are important to understand" for better prose variety.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/en/solutions/Best_Practices_for_Using_Pipelines_in_AI_Scenarios.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/en/solutions/Best_Practices_for_Using_Pipelines_in_AI_Scenarios.md
[style] ~185-~185: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...s method, some basic concepts of Tekton need to be introduced: - EventListener: An...
(REP_NEED_TO_VB)
🪛 markdownlint-cli2 (0.18.1)
docs/en/solutions/Best_Practices_for_Using_Pipelines_in_AI_Scenarios.md
214-214: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
226-226: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
246-246: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
286-286: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
294-294: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
419-419: Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (1)
docs/en/solutions/Best_Practices_for_Using_Pipelines_in_AI_Scenarios.md (1)
366-366: Clarify targetPort value for PAC controller Service.Line 366 sets
targetPort: 8082while the LoadBalancer port is 8080. Verify this is intentional (the controller actually listens on 8082). A past review comment questioned whether the actual listening port is 8080, so confirm the target port is correct to avoid connectivity issues downstream.
Summary by CodeRabbit
Release Notes