cloudFoundryDeleteService

DeleteCloudFoundryService

Description

Delete CloudFoundryService

Usage

We recommend to define values of step parameters via .pipeline/config.yml file.
In this case, calling the step is essentially reduced to defining the step name.
Calling the step can be done either in an orchestrator specific way (e.g. via a Jenkins library step) or on the command line.

JenkinsCommand Line

library('piper-lib-os')

cloudFoundryDeleteService script: this

piper cloudFoundryDeleteService

Prerequisites

This step is for deleting an existing service on Cloud Foundry. You need to provide the Cloud Foundry API Endpoint, the Organisation as well as the Space and the respective Service Instance Name you want to delete. Furthermore you will need to provide the Cloud Foundry Login Credentials, which must be stored in the Jenkins Configuration. Additionally you can set the cfDeleteServiceKeys flag for deleting all Service Keys that belong to the respective Service.

Parameters

Overview - Step

Name	Mandatory	Additional information
cfApiEndpoint	yes
cfOrg	yes
cfServiceInstance	yes
cfSpace	yes
password	(yes)	pass via ENV, Vault or Jenkins credentials (cfCredentialsId)
script	(yes)	reference to Jenkins main pipeline script
username	(yes)	pass via ENV, Vault or Jenkins credentials (cfCredentialsId)
cfDeleteServiceKeys	no
verbose	no	activates debug output

Overview - Execution Environment

Orchestrator-specific only

These parameters are relevant for orchestrator usage and not considered when using the command line option.

Name	Mandatory	Additional information
containerCommand	no
containerShell	no
dockerEnvVars	no
dockerImage	no
dockerName	no
dockerOptions	no
dockerPullImage	no
dockerVolumeBind	no
dockerWorkspace	no

Details

cfApiEndpoint

Cloud Foundry API endpoint

back to overview

Scope	Details
Aliases	cloudFoundry/apiEndpoint
Type	string
Mandatory	yes
Default	$PIPER_cfApiEndpoint (if set)
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

cfDeleteServiceKeys

Parameter to force deletion of Cloud Foundry Service Keys

back to overview

Scope	Details
Aliases	cloudFoundry/cfDeleteServiceKeys
Type	bool
Mandatory	no
Default	false
Possible values	- true - false
Secret	no
Configuration scope	☒ parameter ☐ general ☒ steps ☒ stages
Resource references	none

cfOrg

CF org

back to overview

Scope	Details
Aliases	cloudFoundry/org
Type	string
Mandatory	yes
Default	$PIPER_cfOrg (if set)
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

cfServiceInstance

Parameter of ServiceInstance Name to delete CloudFoundry Service

back to overview

Scope	Details
Aliases	cloudFoundry/serviceInstance
Type	string
Mandatory	yes
Default	$PIPER_cfServiceInstance (if set)
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

cfSpace

CF Space

back to overview

Scope	Details
Aliases	cloudFoundry/space
Type	string
Mandatory	yes
Default	$PIPER_cfSpace (if set)
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

containerCommand

Jenkins-specific: Used for proper environment setup.

Kubernetes only: Allows to specify start command for container created with dockerImage parameter to overwrite Piper default (/usr/bin/tail -f /dev/null).

back to overview

Scope	Details
Aliases	-
Type	string
Mandatory	no
Default
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

containerShell

Jenkins-specific: Used for proper environment setup.

Allows to specify the shell to be executed for container with containerName.

back to overview

Scope	Details
Aliases	-
Type	string
Mandatory	no
Default
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

dockerEnvVars

Environment variables to set in the container, e.g. [http_proxy: "proxy:8080"].

back to overview

Scope	Details
Aliases	-
Type	map[string]string
Mandatory	no
Default
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

dockerImage

Name of the docker image that should be used. If empty, Docker is not used and the command is executed directly on the Jenkins system.

back to overview

Scope	Details
Aliases	-
Type	string
Mandatory	no
Default	ppiper/cf-cli:latest
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

dockerName

Kubernetes only: Name of the container launching dockerImage. SideCar only: Name of the container in local network.

back to overview

Scope	Details
Aliases	-
Type	string
Mandatory	no
Default	cf
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

dockerOptions

Docker options to be set when starting the container.

back to overview

Scope	Details
Aliases	-
Type	[]string
Mandatory	no
Default
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

dockerPullImage

Set this to 'false' to bypass a docker image pull. Useful during development process. Allows testing of images which are available in the local registry only.

back to overview

Scope	Details
Aliases	-
Type	bool
Mandatory	no
Default	true
Possible values	- true - false
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

dockerVolumeBind

Jenkins-specific: Used for proper environment setup.

Volumes that should be mounted into the docker container.

back to overview

Scope	Details
Aliases	-
Type	map[string]string
Mandatory	no
Default
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

dockerWorkspace

Jenkins-specific: Used for proper environment setup.

Kubernetes only: Specifies a dedicated user home directory for the container which will be passed as value for environment variable HOME.

back to overview

Scope	Details
Aliases	-
Type	string
Mandatory	no
Default	/home/piper
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

password

User Password for CF User

back to overview

Scope	Details
Aliases	-
Type	string
Mandatory	yes
Default	$PIPER_password (if set)
Secret	yes
Configuration scope	☒ parameter ☐ general ☒ steps ☒ stages
Resource references	Jenkins credential id:   id: cfCredentialsId   reference to: password Vault resource:   name: cloudfoundryVaultSecretName   default value: cloudfoundry-$(org)-$(space) Vault paths: $(vaultPath)/cloudfoundry-$(org)-$(space) $(vaultBasePath)/$(vaultPipelineName)/cloudfoundry-$(org)-$(space) $(vaultBasePath)/GROUP-SECRETS/cloudfoundry-$(org)-$(space)

script

The common script environment of the Jenkinsfile running. Typically the reference to the script calling the pipeline step is provided with the this parameter, as in script: this. This allows the function to access the commonPipelineEnvironment for retrieving, e.g. configuration parameters.

back to overview

Scope	Details
Aliases	-
Type	Jenkins Script
Mandatory	yes
Default
Secret	no
Configuration scope	☐ parameter ☐ general ☐ steps ☐ stages
Resource references	none

username

User or E-Mail for CF

back to overview

Scope	Details
Aliases	-
Type	string
Mandatory	yes
Default	$PIPER_username (if set)
Secret	yes
Configuration scope	☒ parameter ☐ general ☒ steps ☒ stages
Resource references	Jenkins credential id:   id: cfCredentialsId   reference to: username Vault resource:   name: cloudfoundryVaultSecretName   default value: cloudfoundry-$(org)-$(space) Vault paths: $(vaultPath)/cloudfoundry-$(org)-$(space) $(vaultBasePath)/$(vaultPipelineName)/cloudfoundry-$(org)-$(space) $(vaultBasePath)/GROUP-SECRETS/cloudfoundry-$(org)-$(space)

verbose

verbose output

back to overview

Scope	Details
Aliases	-
Type	bool
Mandatory	no
Default	false
Possible values	- true - false
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

cfCredentialsId

Jenkins 'Username with password' credentials ID containing user and password to authenticate to the Cloud Foundry API.

back to overview

Scope	Details
Aliases	-
Type	string
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages

Example

In this example, the Cloud Foundry Configuration is directly provided with the respective Credentials for the used User/Account.

cloudFoundryDeleteService(
    cfApiEndpoint: 'https://test.server.com',
    cfOrg: 'cforg',
    cfSpace: 'cfspace',
    cfServiceInstance: 'cfserviceInstance',
    cfCredentialsId: 'cfcredentialsId',
    cfDeleteServiceKeys: true,
)