Plugin step settings
This topic provides settings for the CI Plugin step. Plugins are Docker containers that perform predefined tasks and are configured as steps in your stage. Plugins can be used to deploy code, publish artifacts, send notifications, and more.
Depending on the stage's build infrastructure, some settings may be unavailable or located under Optional Configuration.
Enter a name summarizing the step's purpose. Harness automatically assigns an Id (Entity Identifier Reference) based on the Name. You can change the Id.
Optional text string describing the step's purpose.
Container Registry and Image
Container Registry is a Harness container registry connector that has access to Docker Hub. If you have created your own plugin, the connector must have access to the container registry where your plugin image is located.
The name of the plugin's Docker image. The image name should include the tag, or it defaults to the
latest tag if unspecified. For more information about tags, go to Docker build tags.
You can use any Docker image from any Docker registry, including Docker images from private registries.
These fields are located under Optional Configuration for stages that use self-hosted cloud provider VM build infrastructure or Harness Cloud build infrastructure.
Select this option to run the container with escalated privileges. This is the equivalent of running a container with the Docker
Specify plugin-specific settings according to the plugin's documentation. For more information, go to Explore plugins and the Drone plugins documentation.
Output variables are not available for all plugins.
Support for plugin output variables may vary with self-hosted Cloud provider VM build infrastructures.
Output variables are exposed values that can be used by other steps or stages in the pipeline. If the plugin writes outputs to the
.env file present in the
DRONE_OUTPUT path, you can use expressions to reference output variables in other steps and stages in the pipeline.
To reference an output variable in another step in the same stage, use either of the following expressions:
To reference an output variable in a different stage than the one where it originated, use either of the following expressions:
For each expression:
[stepID]with the ID of the Plugin step.
[VAR_NAME]with the relevant variable name.
- In cross-stage references, replace
[stageID]with the ID of the stage where the Plugin step exists.
Image Pull Policy
If you specified a Container Registry and Image, you can specify an image pull policy:
- Always: The kubelet queries the container image registry to resolve the name to an image digest every time the kubelet launches a container. If the kubelet encounters an exact digest cached locally, it uses its cached image; otherwise, the kubelet downloads (pulls) the image with the resolved digest, and uses that image to launch the container.
- If Not Present: The image is pulled only if it isn't already present locally.
- Never: The image is assumed to exist locally. No attempt is made to pull the image.
Run as User
If you specified a Container Registry and Image, you can specify the user ID to use for running processes in containerized steps.
For a Kubernetes cluster build infrastructure, the step uses this user ID to run all processes in the pod. For more information, go to Set the security context for a pod.
Set container resources
Set maximum resource limits for the resources used by the container at runtime:
- Limit Memory: The maximum memory that the container can use. You can express memory as a plain integer or as a fixed-point number using the suffixes
M. You can also use the power-of-two equivalents
Mi. The default is
- Limit CPU: The maximum number of cores that the container can use. CPU limits are measured in CPU units. Fractional requests are allowed; for example, you can specify one hundred millicpu as
100m. The default is
400m. For more information, go to Resource units in Kubernetes.
Set the timeout limit for the step. Once the timeout limit is reached, the step fails and pipeline execution continues. To set skip conditions or failure handling for steps, go to: