Skip to content

Commit

Permalink
Merge pull request #174 from kubeshop/olensmar/docs/rename-clarification
Browse files Browse the repository at this point in the history
added blurb on not being able to rename Workflows/Templates
  • Loading branch information
olensmar authored Nov 14, 2024
2 parents 9577ed7 + ce5ae91 commit 79af6cf
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
7 changes: 6 additions & 1 deletion docs/articles/testkube-dashboard-workflow-details.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,15 @@ Most of the settings in these panels can be configured directly in the Workflow

The General Settings allow you to update the following for your Workflow:

- **Test Workflow name**: Update the description (the name can only be changed in the YAML Definition panel).
- **Test Workflow name**: Update the description for this Workflow.
- **Labels**: Labels that you want to add to this Workflow for filtering/searching/etc.
- **Timeout**: The execution timeout for this Workflow.

:::info
Due to Kubernetes constraints, it is not possible to change the name of a Workflow.
You need to create a copy of the Workflow with the new name and delete the old Workflow instead.
:::

Below these settings there are actions to:

- Delete the Workflow
Expand Down
7 changes: 6 additions & 1 deletion docs/articles/testkube-dashboard-workflows-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,14 @@ Selecting a Workflow Template opens the Settings tab for the Template.

### General Settings

The General settings shown above allow you to specify the name and description of the template, and below that
The General settings shown above allow you to specify the description of the template, and below that
shows an example of how to use this template in a workflow.

:::info
Due to Kubernetes constraints, it is not possible to change the name of a Workflow Template.
You need to create a copy of the Workflow Template with the new name and delete the old Workflow Template instead.
:::

![Workflow Templates Settings](../img/workflow-templates-settings.png)

### Resource Group
Expand Down

0 comments on commit 79af6cf

Please sign in to comment.