oci-factory/oci/temporal-server/documentation.yaml at 1b05f75fb0e6bf9f468c0c1a5c3c3065e44268bd · asanvaq/oci-factory · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
version: 2
application: temporal server
description: |
  Temporal is a durable execution platform that enables developers to build scalable
  applications without sacrificing productivity or reliability. The Temporal server
  executes units of application logic called Workflows in a resilient manner that
  automatically handles intermittent failures, and retries failed operations.

  ## Temporal Server Configuration

  Temporal server must be provided with a configuration file to start up sucessfully.
  We do not include any default configurations in the image. Instead, we expect the
  user to either add a configuration file in the deployed container or mount a volume
  with the config file in the container.

  Some development configuration files can be
  found in [the Temporal repository](https://github.com/temporalio/temporal/tree/main/config).

website: https://github.com/temporalio/temporal
issues: https://github.com/canonical/temporal-rocks/issues
source-code: https://github.com/canonical/temporal-rocks

docker:
  parameters: >-
     -p 7233:7233
     -e SQL_HOST=1.2.3.4
     -v /path/to/temporal/config.yaml:/etc/temporal/config/config.yaml
  run_cmd: >-
    -d
  run_conclusion: |
    Temporal server starts and listens on its configured ports.

    To obtain a runnable configuration, refer to the [official repository](https://github.com/temporalio/temporal).

config:
  TEMPORAL_ROOT:
    type: env
    description: Root directory of Temporal execution environment.
    default: .
  TEMPORAL_CONFIG_DIR:
    type: env
    description: Config directory path relative to the Temporal root.
    default: config
  TEMPORAL_ENVIRONMENT:
    type: env
    description: Run time Temporal environment.
    default: development
  TEMPORAL_AVAILABILITY_ZONE:
    type: env
    description: Temporal's availability zone.
  TEMPORAL_ALLOW_NO_AUTH:
    type: env
    description: Boolean to allow no authorizer.
  SQL_HOST:
    type: env
    description: Hostname or IP address of SQL host to connect to with temporal-sql-tool.
  SQL_PORT:
    type: env
    description: Port of SQL host to connect to with temporal-sql-tool.
  SQL_USER:
    type: env
    description: User name used for authentication when connecting to SQL host with temporal-sql-tool.
  SQL_PASSWORD:
    type: env
    description: Password used for authentication when connecting to SQL host with temporal-sql-tool.
  SQL_DATABASE:
    type: env
    description: Name of SQL database used with temporal-sql-tool.
  SQL_PLUGIN:
    type: env
    description: Name of the SQL plugin for temporal-sql-tool.
  SQL_CONNECT_ATTRIBUTES:
    type: env
    description: SQL connect attributes for temporal-sql-tool.
  SQL_TLS:
    type: env
    description: Enable TLS over SQL connection with temporal-sql-tool.
  SQL_TLS_CERT_FILE:
    type: env
    description: SQL TLS client certificate path for temporal-sql-tool.
  SQL_TLS_KEY_FILE:
    type: env
    description: SQL TLS client key path for temporal-sql-tool.
  SQL_TLS_CA_FILE:
    type: env
    description: SQL TLS client CA file for temporal-sql-tool.
  SQL_TLS_SERVER_NAME:
    type: env
    description: Override for target server name with temporal-sql-tool.
  SQL_TLS_DISABLE_HOST_VERIFICATION:
    type: env
    description: Disable TLS host name verifaction with temporal-sql-tool (tls must be enabled).
  TEMPORAL_CLI_ADDRESS:
    type: env
    description: host:port for Temporal frontend service used by tdbg.
  TEMPORAL_CLI_NAMESPACE:
    type: env
    description: Temporal workflow namespace used by tdbg.
  TEMPORAL_CONTEXT_TIMEOUT:
    type: env
    description: Optional timeout for context of RPC calls in seconds for tdbg.
  TEMPORAL_CLI_TLS_CERT:
    type: env
    description: Path to x509 certificate used by tdbg.
  TEMPORAL_CLI_TLS_KEY:
    type: env
    description: Path to private key used by tdbg.
  TEMPORAL_CLI_TLS_CA:
    type: env
    description: Path to server CA certificate used by tdbg.
  TEMPORAL_CLI_TLS_DISABLE_HOST_VERFICATION:
    type: env
    description: Disable TLS host name verification for tdbg (tls must be enabled).
  '`-v <path>:/etc/temporal/config/config.yaml`':
    type: mount
    description: Local configuration file for Temporal server.
  '`-p <port>:6933`':
    type: port
    description: Expose Temporal's fronted service membership endpoint.
  '`-p <port>:6934`':
    type: port
    description: Expose Temporal's history service membership endpoint.
  '`-p <port>:6935`':
    type: port
    description: Expose Temporal's matching service membership endpoint.
  '`-p <port>:6939`':
    type: port
    description: Expose Temporal's worker service membership endpoint.
  '`-p <port>:7233`':
    type: port
    description: Expose Temporal's frontend service GRPC endpoint.
  '`-p <port>:7243`':
    type: port
    description: Expose Temporal's frontend service HTTP endpoint.
  '`-p <port>:7234`':
    type: port
    description: Expose Temporal's history service GRPC endpoint.
  '`-p <port>:7235`':
    type: port
    description: Expose Temporal's matching service GRPC endpoint.
  '`-p <port>:7239`':
    type: port
    description: Expose Temporal's worker service GRPC endpoint.