Skip to content

Commit f5c2616

Browse files
asanvaqCopilotalesancor1
authored
docs: migrate to v2 istio-ztunnel (#955)
* docs: migrate to v2 istio-ztunnel * docs: fix parameters * docs: update formatting Co-authored-by: Copilot <copilot@github.com> * docs: update port text * docs: apply suggestions from code review Co-authored-by: Alejandro Santisteban <alex.santisteban@canonical.com> --------- Co-authored-by: Copilot <copilot@github.com> Co-authored-by: Alejandro Santisteban <alex.santisteban@canonical.com>
1 parent 68d1ce8 commit f5c2616

1 file changed

Lines changed: 19 additions & 31 deletions

File tree

Lines changed: 19 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,26 @@
1-
version: 1
2-
# --- OVERVIEW INFORMATION ---
1+
version: 2
32
application: ztunnel
4-
description: >
3+
description: |
54
Ztunnel is a purpose built implementation of the node proxy
65
to be used as the ztunnel component of Istio's ambient mesh.
7-
Read more on the [project repo](https://github.com/istio/ztunnel).
6+
website: https://github.com/istio/ztunnel
7+
issues: https://github.com/canonical/istio-ztunnel-rock/issues
8+
source-code: https://github.com/canonical/istio-ztunnel-rock
89

9-
# --- USAGE INFORMATION ---
1010
docker:
11-
parameters:
12-
- -p 15020:15020
13-
access: Access your Ztunnel instance at `http://localhost:15020`.
11+
parameters: >-
12+
-p 15020:15020
13+
run_conclusion: |
14+
Access the Ztunnel instance at `http://localhost:15020`.
1415
15-
parameters:
16-
- type: -e
17-
value: 'TZ=UTC'
16+
config:
17+
'`TZ`':
18+
type: env
1819
description: Timezone setting for the container.
19-
- type: -p
20-
value: '15020:15020'
21-
description: Port mapping for the Ztunnel process.
22-
- type: CMD
23-
value: "ztunnel proxy"
24-
description: >
25-
Launch Ztunnel in proxy mode (default).
26-
27-
debug:
28-
text: |
29-
### Debugging
30-
31-
To debug the container:
32-
```bash
33-
docker exec -it ztunnel-container pebble logs -f ztunnel
34-
```
35-
To get an interactive shell:
36-
```bash
37-
docker exec -it ztunnel-container /bin/bash
38-
```
20+
default: 'UTC'
21+
'`-p <port>:15020`':
22+
type: port
23+
description: Expose the container's port `15020` on the host's `<port>`.
24+
'`ztunnel proxy`':
25+
type: app
26+
description: Launch ztunnel in proxy mode.

0 commit comments

Comments
 (0)