sap.sap_operations.cf_service_instance (1.25.0) — module

Install collection

Install with ansible-galaxy collection install sap.sap_operations:==1.25.0

Add to requirements.yml

  collections:
    - name: sap.sap_operations
      version: 1.25.0

Description

This plugin allows managing service instances in a Cloud Foundry environment.

It can create, delete service instances.

Plugin is idempotent it will not create service instance with the same name it is already exists.

Plugin will not change service instance parameters or metadata if service instance already exists (this functionality is planned)

Requirements

• python >= 3.6
• cf CLI should be installed and available in PATH

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

---
- name: Create a service instance
  sap.sap_operations.cf_service_instance:
    name: my_service_instance
    service: my_service
    state: present
    space: my_space
    service_plan: my_service_plan
    parameters:
      param1: value1
      param2: value2
    metadata:
      label1: value1
      label2: value2

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete a service instance
  sap.sap_operations.cf_service_instance:
    name: my_service_instance
    service: my_service
    state: absent
    space: my_space

Inputs

    
name:
    description: The name of the service instance.
    required: true
    type: str

space:
    description: The name of the space in which to manage the service instance.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description: The desired state of the service instance.
    required: false
    type: str

service:
    description: The name of the service offering.
    required: true
    type: str

metadata:
    description: A dictionary containing metadata for the service instance.
    required: false
    type: dict

password:
    description:
    - The password for authentication with the Cloud Foundry API.
    required: false
    type: str

username:
    description:
    - The username for authentication with the Cloud Foundry API.
    - This is SAP BTP user email address
    required: false
    type: str

parameters:
    description: A dictionary containing configuration parameters for the service instance.
    required: false
    type: dict

api_endpoint:
    description:
    - The endpoint URL of the Cloud Foundry API.
    required: false
    type: str

service_plan:
    description: The name of the service plan for the service instance.
    required: false
    type: str