Skip to content

config

These configuration classes define how to connect to a Zeebe instance.

Keys given in description must be used if you prefer to set up connection using environmental variables.

In addition, you must set CAMUNDA_CONNECTION_TYPE to either SECURE, INSECURE or CAMUNDA_CLOUD.

Example Cloud config:

from python_camunda_sdk import CloudConfig

config = CloudConfig(
    client_id='jYsgv.SryJYQlcpobk-tZZP~2R60xpNY',
    client_secret='55kddTbk~yZBFb2NH5GtebWHkSoK1z.TG7G1Hn-n.mH_f4ihpZAUop1-sryxHnyV',
    cluster_id='7bc802fc-7bf4-4800-b84a-596628d1ed08',
    region='bru-2'
)

Example Insecure config:

from python_camunda_sdk import InsecureConfig

config = InsecureConfig(
    host='127.0.0.1',
    port=26500
)

Example secure config:

config = SecureConfig(
    host='127.0.0.1',
    port=26500,
    root_certificates='''
    -----BEGIN CERTIFICATE-----
    xxx
    -----BEGIN CERTIFICATE-----
    '''
    private_key='''
    -----BEGIN RSA PRIVATE KEY-----
    xxx
    -----BEGIN RSA PRIVATE KEY-----
    '''
    certificate_chain=''
)

ConnectionConfig

Bases: BaseModel

Base class for connection configuration.

Source code in python_camunda_sdk/runtime/config.py 
 9
10
11
12
class ConnectionConfig(BaseModel):
    """Base class for connection configuration."""

    pass

CloudConfig

Bases: ConnectionConfig

Configuration for connection to Camunda SaaS.

Attributes:

Name Type Description
client_id str

CAMUNDA_CLIENT_ID
client_secret str

CAMUNDA_CLIENT_SECRET
cluster_id str

CAMUNDA_CLUSTER_ID
region str

CAMUNDA_REGION
Source code in python_camunda_sdk/runtime/config.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
class CloudConfig(ConnectionConfig):
    """Configuration for connection to Camunda SaaS.

    Attributes:
        client_id: `CAMUNDA_CLIENT_ID`
        client_secret: `CAMUNDA_CLIENT_SECRET`
        cluster_id: `CAMUNDA_CLUSTER_ID`
        region: `CAMUNDA_REGION`
    """

    client_id: str = Field(
        json_schema_extra={
            "env_var": "CAMUNDA_CLIENT_ID"
        }
    )
    client_secret: str = Field(
        json_schema_extra={
            "env_var": "CAMUNDA_CLIENT_SECRET"
        }
    )
    cluster_id: str = Field(
        json_schema_extra={
            "env_var": "CAMUNDA_CLUSTER_ID"
        }
    )
    region: str = Field(
        json_schema_extra={
            "env_var": "CAMUNDA_REGION"
        }
    )

InsecureConfig

Bases: ConnectionConfig

Configuration for connecting insecurely to self-hosted Zeebe instance.

Attributes:

Name Type Description
hostname str

ZEBEE_HOSTNAME
port Optional[int]

ZEBEE_PORT
Source code in python_camunda_sdk/runtime/config.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
class InsecureConfig(ConnectionConfig):
    """Configuration for connecting insecurely to self-hosted Zeebe
    instance.

    Attributes:
        hostname: `ZEBEE_HOSTNAME`
        port: `ZEBEE_PORT`
    """

    hostname: str = Field(
        json_schema_extra={
            "env_var": "ZEBEE_HOSTNAME"
        }
    )
    port: Optional[int] = Field(
        default=26500,
        json_schema_extra={
            "env_var": "ZEBEE_PORT"
        }
    )

SecureConfig

Bases: InsecureConfig

Configuration for connecting securely to self-hosted Zeebe instance.

Warning

In addition should have hostname and port set.

Attributes:

Name Type Description
root_certificates str

SSL_ROOT_CA
private_key str

SSL_PRIVATE_KEY
certificate_chain Optional[str]

SSL_CERTIFICATE_CHAIN
Source code in python_camunda_sdk/runtime/config.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
class SecureConfig(InsecureConfig):
    """Configuration for connecting securely to self-hosted Zeebe
    instance.

    !!! warning
        In addition should have hostname and port set.

    Attributes:
        root_certificates: `SSL_ROOT_CA`
        private_key: `SSL_PRIVATE_KEY`
        certificate_chain: `SSL_CERTIFICATE_CHAIN`
    """

    root_certificates: str = Field(
        json_schema_extra={
            "env_var": "SSL_ROOT_CA"
        }
    )
    private_key: str = Field(
        json_schema_extra={
            "env_var": "SSL_PRIVATE_KEY"
        }
    )
    certificate_chain: Optional[str] = Field(
        default=None,
        json_schema_extra={
            "env_var": "SSL_CERTIFICATE_CHAIN"
        }
    )