Skip to content

Commit 4a29edd

Browse files
asanvaqzhijie-yang
asanvaq
and
zhijie-yang
authored
docs: migrate to v2 temporal-server (#951)
* docs: migrate to v2 temporal-server * docs: fix parameters Co-authored-by: zhijie-yang <zhijie.yang@canonical.com> * docs: apply feedback * docs: improve based on temporal-io feedback * docs: Apply suggestions from code review Co-authored-by: zhijie-yang <zhijie.yang@canonical.com> --------- Co-authored-by: zhijie-yang <zhijie.yang@canonical.com>
1 parent f29c145 commit 4a29edd

1 file changed

Lines changed: 131 additions & 128 deletions

File tree

‎oci/temporal-server/documentation.yaml‎

Lines changed: 131 additions & 128 deletions
Original file line numberDiff line numberDiff line change
@@ -1,136 +1,139 @@
1-
version: 1
2-
1+
version: 2
32
application: temporal server
4-
description: >
5-
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.
6-
7-
docker:
8-
parameters:
9-
- -p 7233:7233
10-
- -e SQL_HOST=1.2.3.4
11-
- -v /path/to/temporal/config.yaml:/etc/temporal/config/config.yaml
12-
access: |
13-
### New entrypoint `pebble`
3+
description: |
4+
Temporal is a durable execution platform that enables developers to build scalable
5+
applications without sacrificing productivity or reliability. The Temporal server
6+
executes units of application logic called Workflows in a resilient manner that
7+
automatically handles intermittent failures, and retries failed operations.
148
15-
Please note that the entrypoint of the images in this repository is [Pebble](https://documentation.ubuntu.com/pebble/), a lightweight service manager. The pebble process launches and supervises the temporal-server process.
9+
## Temporal Server Configuration
1610
17-
#### Temporal Server Configuration
11+
Temporal server must be provided with a configuration file to start up sucessfully.
12+
We do not include any default configurations in the image. Instead, we expect the
13+
user to either add a configuration file in the deployed container or mount a volume
14+
with the config file in the container.
1815
19-
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.
16+
Some development configuration files can be
17+
found in [the Temporal repository](https://github.com/temporalio/temporal/tree/main/config).
2018
21-
Some development configuration files can be found in [the temporal repository](https://github.com/temporalio/temporal/tree/main/config).
19+
website: https://github.com/temporalio/temporal
20+
issues: https://github.com/canonical/temporal-rocks/issues
21+
source-code: https://github.com/canonical/temporal-rocks
2222

23-
The following outlines steps to mount the development configuration files while launching a container:
24-
25-
```sh
26-
$ git clone https://github.com/temporalio/temporal
23+
docker:
24+
parameters: >-
25+
-d
26+
-p 7233:7233
27+
-e SQL_HOST=1.2.3.4
28+
-v /path/to/temporal/config.yaml:/etc/temporal/config/config.yaml
29+
run_conclusion: |
30+
Temporal server starts and listens on its configured ports.
2731
28-
$ docker run -d --name temporal-server-container -e TZ=UTC -p 7233:7233 -v ./temporal/config:/etc/temporal/config -e TEMPORAL_ENVIRONMENT=development-sqlite ubuntu/temporal-server:1.23.1-24.04_edge
29-
```
32+
To obtain a runnable configuration, refer to the [official repository](https://github.com/temporalio/temporal).
3033
31-
parameters:
32-
- type: -e
33-
value: 'TEMPORAL_ROOT=/etc/temporal'
34-
description: Root directory of Temporal execution environment
35-
- type: -e
36-
value: 'TEMPORAL_CONFIG_DIR=config'
37-
description: Config directory path relative to the Temporal root
38-
- type: -e
39-
value: 'TEMPORAL_ENVIRONMENT=development'
40-
description: Run time Temporal environment
41-
- type: -e
42-
value: 'TEMPORAL_AVAILABILITY_ZONE=some-zone'
43-
description: Temporal's availability zone
44-
- type: -e
45-
value: 'TEMPORAL_ALLOW_NO_AUTH=false'
46-
description: Boolean to allow no authorizer
47-
- type: -p
48-
value: '6933:6933'
49-
description: Expose Temporal's fronted service membership endpoint
50-
- type: -p
51-
value: '6934:6934'
52-
description: Expose Temporal's history service membership endpoint
53-
- type: -p
54-
value: '6935:6935'
55-
description: Expose Temporal's matching service membership endpoint
56-
- type: -p
57-
value: '6939:6939'
58-
description: Expose Temporal's worker service membership endpoint
59-
- type: -p
60-
value: '7233:7233'
61-
description: Expose Temporal's frontend service GRPC endpoint
62-
- type: -p
63-
value: '7243:7243'
64-
description: Expose Temporal's frontend service HTTP endpoint
65-
- type: -p
66-
value: '7234:7234'
67-
description: Expose Temporal's history service GRPC endpoint
68-
- type: -p
69-
value: '7235:7235'
70-
description: Expose Temporal's matching service GRPC endpoint
71-
- type: -p
72-
value: '7239:7239'
73-
description: Expose Temporal's worker service GRPC endpoint
74-
- type: -v
75-
value: "/path/to/temporal/config.yaml:/etc/temporal/config/config.yaml"
76-
description: Local configuration file for Temporal server
77-
- type: -e
78-
value: 'SQL_HOST=1.2.3.4'
79-
description: Hostname or IP address of SQL host to connect to with temporal-sql-tool
80-
- type: -e
81-
value: 'SQL_PORT=3306'
82-
description: Port of SQL host to connect to with temporal-sql-tool
83-
- type: -e
84-
value: 'SQL_USER=mysql'
85-
description: User name used for authentication when connecting to SQL host with temporal-sql-tool
86-
- type: -e
87-
value: 'SQL_PASSWORD=supersecretpassword'
88-
description: Password used for authentication when connecting to SQL host with temporal-sql-tool
89-
- type: -e
90-
value: 'SQL_DATABASE=temporal'
91-
description: Name of SQL database used with temporal-sql-tool
92-
- type: -e
93-
value: 'SQL_PLUGIN=mysql'
94-
description: Name of the SQL plugin for temporal-sql-tool
95-
- type: -e
96-
value: 'SQL_CONNECT_ATTRIBUTES'
97-
description: SQL connect attributes for temporal-sql-tool
98-
- type: -e
99-
value: 'SQL_TLS=true'
100-
description: Enable TLS over SQL connection with temporal-sql-tool
101-
- type: -e
102-
value: 'SQL_TLS_CERT_FILE=/path/to/client.crt'
103-
description: SQL TLS client certificate path for temporal-sql-tool
104-
- type: -e
105-
value: 'SQL_TLS_KEY_FILE=/path/to/client.key'
106-
description: SQL TLS client key path for temporal-sql-tool
107-
- type: -e
108-
value: 'SQL_TLS_CA_FILE=/path/to/client-ca.crt'
109-
description: SQL TLS client CA file for temporal-sql-tool
110-
- type: -e
111-
value: 'SQL_TLS_SERVER_NAME=test-server-name'
112-
description: Override for target server name with temporal-sql-tool
113-
- type: -e
114-
value: 'SQL_TLS_DISABLE_HOST_VERIFICATION=true'
115-
description: Disable TLS host name verifaction with temporal-sql-tool (tls must be enabled)
116-
- type: -e
117-
value: 'TEMPORAL_CLI_ADDRESS=1.2.3.4:5555'
118-
description: host:port for Temporal frontend service used by tdbg
119-
- type: -e
120-
value: 'TEMPORAL_CLI_NAMESPACE=testnamespace'
121-
description: Temporal workflow namespace used by tdbg
122-
- type: -e
123-
value: 'TEMPORAL_CONTEXT_TIMEOUT=10'
124-
description: Optional timeout for context of RPC calls in seconds for tdbg
125-
- type: -e
126-
value: 'TEMPORAL_CLI_TLS_CERT=/path/to/tls.cert'
127-
description: Path to x509 certificate used by tdbg
128-
- type: -e
129-
value: 'TEMPORAL_CLI_TLS_KEY=/path/to/tls.key'
130-
description: Path to private key used by tdbg
131-
- type: -e
132-
value: 'TEMPORAL_CLI_TLS_CA=/path/to/server-ca.crt'
133-
description: Path to server CA certificate used by tdbg
134-
- type: -e
135-
value: 'TEMPORAL_CLI_TLS_DISABLE_HOST_VERFICATION=true'
136-
description: Disable TLS host name verification for tdbg (tls must be enabled)
34+
config:
35+
TEMPORAL_ROOT:
36+
type: env
37+
description: Root directory of Temporal execution environment.
38+
TEMPORAL_CONFIG_DIR:
39+
type: env
40+
description: Config directory path relative to the Temporal root.
41+
TEMPORAL_ENVIRONMENT:
42+
type: env
43+
description: Run time Temporal environment.
44+
TEMPORAL_AVAILABILITY_ZONE:
45+
type: env
46+
description: Temporal's availability zone.
47+
TEMPORAL_ALLOW_NO_AUTH:
48+
type: env
49+
description: Boolean to allow no authorizer.
50+
SQL_HOST:
51+
type: env
52+
description: Hostname or IP address of SQL host to connect to with temporal-sql-tool.
53+
SQL_PORT:
54+
type: env
55+
description: Port of SQL host to connect to with temporal-sql-tool.
56+
SQL_USER:
57+
type: env
58+
description: User name used for authentication when connecting to SQL host with temporal-sql-tool.
59+
SQL_PASSWORD:
60+
type: env
61+
description: Password used for authentication when connecting to SQL host with temporal-sql-tool.
62+
SQL_DATABASE:
63+
type: env
64+
description: Name of SQL database used with temporal-sql-tool.
65+
SQL_PLUGIN:
66+
type: env
67+
description: Name of the SQL plugin for temporal-sql-tool.
68+
SQL_CONNECT_ATTRIBUTES:
69+
type: env
70+
description: SQL connect attributes for temporal-sql-tool.
71+
SQL_TLS:
72+
type: env
73+
description: Enable TLS over SQL connection with temporal-sql-tool.
74+
SQL_TLS_CERT_FILE:
75+
type: env
76+
description: SQL TLS client certificate path for temporal-sql-tool.
77+
SQL_TLS_KEY_FILE:
78+
type: env
79+
description: SQL TLS client key path for temporal-sql-tool.
80+
SQL_TLS_CA_FILE:
81+
type: env
82+
description: SQL TLS client CA file for temporal-sql-tool.
83+
SQL_TLS_SERVER_NAME:
84+
type: env
85+
description: Override for target server name with temporal-sql-tool.
86+
SQL_TLS_DISABLE_HOST_VERIFICATION:
87+
type: env
88+
description: Disable TLS host name verifaction with temporal-sql-tool (tls must be enabled).
89+
TEMPORAL_CLI_ADDRESS:
90+
type: env
91+
description: host:port for Temporal frontend service used by tdbg.
92+
TEMPORAL_CLI_NAMESPACE:
93+
type: env
94+
description: Temporal workflow namespace used by tdbg.
95+
TEMPORAL_CONTEXT_TIMEOUT:
96+
type: env
97+
description: Optional timeout for context of RPC calls in seconds for tdbg.
98+
TEMPORAL_CLI_TLS_CERT:
99+
type: env
100+
description: Path to x509 certificate used by tdbg.
101+
TEMPORAL_CLI_TLS_KEY:
102+
type: env
103+
description: Path to private key used by tdbg.
104+
TEMPORAL_CLI_TLS_CA:
105+
type: env
106+
description: Path to server CA certificate used by tdbg.
107+
TEMPORAL_CLI_TLS_DISABLE_HOST_VERFICATION:
108+
type: env
109+
description: Disable TLS host name verification for tdbg (tls must be enabled).
110+
'`-v <path>:/etc/temporal/config/config.yaml`':
111+
type: mount
112+
description: Local configuration file for Temporal server.
113+
'`-p <port>:6933`':
114+
type: port
115+
description: Expose Temporal's fronted service membership endpoint.
116+
'`-p <port>:6934`':
117+
type: port
118+
description: Expose Temporal's history service membership endpoint.
119+
'`-p <port>:6935`':
120+
type: port
121+
description: Expose Temporal's matching service membership endpoint.
122+
'`-p <port>:6939`':
123+
type: port
124+
description: Expose Temporal's worker service membership endpoint.
125+
'`-p <port>:7233`':
126+
type: port
127+
description: Expose Temporal's frontend service GRPC endpoint.
128+
'`-p <port>:7243`':
129+
type: port
130+
description: Expose Temporal's frontend service HTTP endpoint.
131+
'`-p <port>:7234`':
132+
type: port
133+
description: Expose Temporal's history service GRPC endpoint.
134+
'`-p <port>:7235`':
135+
type: port
136+
description: Expose Temporal's matching service GRPC endpoint.
137+
'`-p <port>:7239`':
138+
type: port
139+
description: Expose Temporal's worker service GRPC endpoint.

0 commit comments

Comments
 (0)