Configuring your pipelines for management with code
To begin managing your existing pipelines with code, or to create new pipelines using
a .cd4pe.yaml
file, follow the instructions on this page
appropriate to your circumstances.
Have you added your control repo or module to Continuous Delivery for PE? | Do you have a .cd4pe.yaml file
containing the pipeline definitions you want to use? |
Follow these instructions |
---|---|---|
yes | not yet | Convert your existing pipelines to code |
yes | yes | Update your
pipelines using a new .cd4pe.yaml file |
not yet | yes | Create new pipelines
using a .cd4pe.yaml
file |
Convert your existing pipelines to code
If you've created pipelines using the Continuous Delivery for PE web UI, but now want to manage those pipelines with code, Continuous Delivery for PE will render your existing pipelines in YAML format.
.cd4pe.yaml
file before every pipeline run, and uses the
YAML code to render the pipelines' definitions in the web UI. Because you're managing
your pipelines with code, the pipeline controls in the web UI are disabled. Update your pipelines using a new .cd4pe.yaml
file
If you've created pipelines using the Continuous Delivery for PE web UI, but
now want to update those pipelines to use new definitions housed in a .cd4pe.yaml
file, you can do so by saving the file to your control repo or
module.
.cd4pe.yaml
file
containing the definitions of the pipelines you want to create. For more on .cd4pe.yaml
file syntax, see Structuring a .cd4pe.yaml file. .cd4pe.yaml
file before every pipeline run, and uses the
YAML code to render the pipelines' definitions in the web UI. Because you're managing
your pipelines with code, the pipeline controls in the web UI are disabled. Create new pipelines using a .cd4pe.yaml
file
You can create pipelines with code for a brand-new control repo or module in Continuous Delivery for PE. If a .cd4pe.yaml
file
exists in your control repo or module when it is first added to Continuous Delivery for PE, the software will detect this file and ask if you want to
use it to build and manage your pipelines.
.cd4pe.yaml
file before every pipeline run, and uses the
YAML code to render the pipelines' definitions in the web UI. Because you're managing
your pipelines with code, the pipeline controls in the web UI are disabled. Stop managing your pipelines with code
If you want to stop managing your pipelines with a .cd4pe.yaml
file, and return to using the pipeline controls in the web UI, use
the Manage pipelines control to make the switch.
-
In the Continuous Delivery for PE web UI, navigate to the control repo
or module whose pipelines you are currently managing with a
.cd4pe.yaml
file. - At the top of the Pipelines section, click Manage pipelines.
- Select Manage in the web UI and make any needed adjustments to your pipeline settings.
- Click Save settings.
.cd4pe.yaml
file is now ignored by Continuous Delivery for PE, and
all pipeline changes must be made in the web UI. .cd4pe.yaml
file from your control repo
or module.