feat: Doc for dynamically executing the Pipeline #9523
Conversation
krishi0408
requested review from
vishal-av and
SudarshanPurohit
as code owners
|
|
|
Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://67beef20d47d4900a8929052--harness-developer.netlify.app |
|
|
||
| ### YAML Configuration | ||
|
|
||
| You need to provide valid YAML configuration provided through Dynamic Execution API. |
There was a problem hiding this comment.
Add a link to APIDocs , linking to the specific API here. Also name it here so users know what to look for.
There was a problem hiding this comment.
Yes will add the same here
|
|
||
| Users need both [**Edit and Execute**](/docs/platform/role-based-access-control/add-manage-roles.md) permissions on the Pipelines. | ||
|
|
||
| ### YAML Configuration |
There was a problem hiding this comment.
Not sure what "YAML Configuration" means in this context? I assume you want to explain "How to use the feature" - which is only through the API. We should clarify here that we don't support Dynamic Executions through UI (by design).
| You need to provide valid YAML configuration provided through Dynamic Execution API. | ||
|
|
||
| ## Dynamic Execution API | ||
|
|
There was a problem hiding this comment.
Also, how does a user know that a pipeline was run dynamically? there's a few icons on the UI - let's list them here.
There was a problem hiding this comment.
Yes need to add the same. In the execution we show whether it was triggered dynamically or not, I will add the same .
| description: You can dynamically execute pipelines in Harness. | ||
| --- | ||
|
|
||
| Dynamic execution of Pipelines allows you to execute pipelines by providing pipeline YAML configuration during runtime without requiring pre-saved configurations in Harness. This enables seamless integration with user existing ecosystem while maintanining Harness's robust security and governance controls. |
There was a problem hiding this comment.
I think its worth expanding the use case a little. Essentially we are using Harness as a pure Execution engine, letting an external system, somewhere in the ecosystem, do the YAML creation and editing. This is useful when Pipelines are being generated on the fly based on user actions.
There was a problem hiding this comment.
Sure will add more details on the use case
|
Hi @SudarshanPurohit this is just the first draft. Have asked Brijesh to provide me the API, couldn't find the same in API docs. Will add more details on the same. Had some queries in the API that I saw in the channel so will add the same once I try out the same. For now, I have added the basic details. Will incorporate the changes you mentioned in the PR. Thanks |
|
Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://67bf39ed484a9ba23e2314b9--harness-developer.netlify.app |
Thanks for contributing to the Harness Developer Hub! Our code owners will review your submission.
Description
PR lifecycle
We aim to merge PRs within one week or less, but delays happen sometimes.
If your PR is open longer than two weeks without any human activity, please tag a code owner in a comment.
PRs must meet these requirements to be merged: