Pipeline

pipeline

This is a module that supports creating, updating or destroying Pipelines

Example Syntax

name: Create Pipeline
ionoscloudsdk.ionoscloud.pipeline:
  name: 'ansiblepipelinetest'
  logs: '[{'source': 'kubernetes', 'tag': 'tag', 'protocol': 'http', 'destinations': [{'type': 'loki', 'retention_in_days': 7}]}]'
  wait: true
  wait_timeout: 1200
register: pipeline_response


name: Update pipeline
ionoscloudsdk.ionoscloud.pipeline:
  pipeline: ''
  name: 'ansiblepipeNEW'
  logs: '[{'source': 'docker', 'tag': 'differenttag', 'protocol': 'tcp', 'labels': ['1'], 'destinations': [{'type': 'loki', 'retention_in_days': 14}]}, {'source': 'kubernetes', 'tag': 'updatedtag', 'protocol': 'http', 'labels': ['2'], 'destinations': [{'type': 'loki', 'retention_in_days': 14}]}]'
  state: update
register: updated_pipeline_response


name: Delete pipeline
ionoscloudsdk.ionoscloud.pipeline:
  pipeline: ''
  wait: true
  state: absent


name: Renew Pipeline key
ionoscloudsdk.ionoscloud.pipeline:
  pipeline: ''
  state: renew

Returned object

{
    "changed": true,
    "failed": false,
    "action": "update",
    "pipeline": {
        "id": "f30a1c8f-334d-4238-b259-b0a761a87352",
        "type": "Pipeline",
        "metadata": {
            "created_date": "2023-10-17T15:19:14+00:00",
            "created_by": "<USER_EMAIL>",
            "created_by_user_id": "<USER_ID>",
            "created_by_user_uuid": "<USER_UUID>",
            "last_modified_date": "2023-10-17T15:21:02+00:00",
            "last_modified_by": "<USER_EMAIL>",
            "last_modified_by_user_id": "<USER_ID>",
            "last_modified_by_user_uuid": "<USER_UUID>",
            "status": "AVAILABLE"
        },
        "properties": {
            "name": "ansiblepipelinetest123UPDATED",
            "logs": [
                {
                    "public": false,
                    "source": "docker",
                    "tag": "differenttag",
                    "protocol": "tcp",
                    "labels": [
                        "new_label"
                    ],
                    "destinations": [
                        {
                            "type": "loki",
                            "retention_in_days": 14
                        }
                    ]
                },
                {
                    "public": false,
                    "source": "kubernetes",
                    "tag": "updatedtag",
                    "protocol": "http",
                    "labels": [
                        "label"
                    ],
                    "destinations": [
                        {
                            "type": "loki",
                            "retention_in_days": 14
                        }
                    ]
                }
            ],
            "tcp_address": "",
            "http_address": "<HTTP_ADDRESS>",
            "grafana_address": "<GRAFANA_ADDRESS>"
        }
    }
}

For more examples please check out the tests here.

state: present

  
name: Create Pipeline
ionoscloudsdk.ionoscloud.pipeline:
  name: 'ansiblepipelinetest'
  logs: '[{'source': 'kubernetes', 'tag': 'tag', 'protocol': 'http', 'destinations': [{'type': 'loki', 'retention_in_days': 7}]}]'
  wait: true
  wait_timeout: 1200
register: pipeline_response

Available parameters for state present:

Name	Required	Description
name str	True	The name of the pipeline. Must be not more that 20 characters long.
logs list	True	The information of the log pipelines
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update', 'renew']

state: absent

  
name: Delete pipeline
ionoscloudsdk.ionoscloud.pipeline:
  pipeline: ''
  wait: true
  state: absent

Available parameters for state absent:

Name	Required	Description
pipeline str	True	The ID or name of an existing Pipeline.
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update', 'renew']

state: update

  
name: Update pipeline
ionoscloudsdk.ionoscloud.pipeline:
  pipeline: ''
  name: 'ansiblepipeNEW'
  logs: '[{'source': 'docker', 'tag': 'differenttag', 'protocol': 'tcp', 'labels': ['1'], 'destinations': [{'type': 'loki', 'retention_in_days': 14}]}, {'source': 'kubernetes', 'tag': 'updatedtag', 'protocol': 'http', 'labels': ['2'], 'destinations': [{'type': 'loki', 'retention_in_days': 14}]}]'
  state: update
register: updated_pipeline_response

Available parameters for state update:

Name	Required	Description
name str	False	The name of the pipeline. Must be not more that 20 characters long.
logs list	False	The information of the log pipelines
pipeline str	True	The ID or name of an existing Pipeline.
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update', 'renew']

state: renew

  
name: Renew Pipeline key
ionoscloudsdk.ionoscloud.pipeline:
  pipeline: ''
  state: renew

Available parameters for state renew:

Name	Required	Description
pipeline str	True	The ID or name of an existing Pipeline.
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update', 'renew']