Skip to content

Commit

Permalink
Updates services documentation
Browse files Browse the repository at this point in the history
Removes references to Blockdiag and Wireviz Docker images and containers
  • Loading branch information
xavier-calland committed Oct 16, 2023
1 parent 8353366 commit 7623daf
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 51 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/cve-scan.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
continue-on-error: true
strategy:
matrix:
image: [ kroki, kroki-mermaid, kroki-bpmn, kroki-excalidraw, kroki-diagramsnet, kroki-wireviz ]
image: [ kroki, kroki-mermaid, kroki-bpmn, kroki-excalidraw, kroki-diagramsnet ]
tag: [ latest ]
steps:
- name: Run Trivy vulnerability scanner
Expand Down
8 changes: 0 additions & 8 deletions .github/workflows/dockerhub-description.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,3 @@ jobs:
short-description: Companion server for Kroki that provides diagrams.net (formerly draw.io)
readme-filepath: ./DOCKERHUB-COMPANION.md

- name: Docker Hub Description - wireviz
uses: peter-evans/[email protected]
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: yuzutech/kroki-wireviz
short-description: Companion server for Kroki that provides WireViz
readme-filepath: ./DOCKERHUB-COMPANION.md
6 changes: 0 additions & 6 deletions DOCKERHUB.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ services:
- KROKI_MERMAID_HOST=mermaid
- KROKI_BPMN_HOST=bpmn
- KROKI_EXCALIDRAW_HOST=excalidraw
- KROKI_WIREVIZ_HOST=wireviz
ports:
- "8000:8000"
mermaid:
Expand All @@ -54,10 +53,6 @@ services:
image: yuzutech/kroki-excalidraw
ports:
- "8004:8004"
wireviz:
image: yuzutech/kroki-wireviz
ports:
- "8006:8006"
```

If you don't want to use `docker-compose`, you can configure the host and port for each companion container using environment variables:
Expand All @@ -67,7 +62,6 @@ If you don't want to use `docker-compose`, you can configure the host and port f
| `kroki-mermaid` | `KROKI_MERMAID_HOST` | `KROKI_MERMAID_PORT` |
| `kroki-bpmn` | `KROKI_BPMN_HOST` | `KROKI_BPMN_PORT` |
| `kroki-excalidraw` | `KROKI_EXCALIDRAW_HOST` | `KROKI_EXCALIDRAW_PORT` |
| `kroki-wireviz` | `KROKI_WIREVIZ_HOST` | `KROKI_WIREVIZ_PORT` |

For Kubernetes installation follow the description in [install using Kubernetes](https://docs.kroki.io/kroki/setup/install/#_using_kubernetes) section.

Expand Down
30 changes: 10 additions & 20 deletions docs/modules/ROOT/pages/architecture.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,6 @@ A companion web server written in JavaScript (powered by _micro_) that provides
Diagrams.net::
A companion web server written in JavaScript (powered by _micro_) that provides https://www.diagrams.net/[_diagrams.net_] to render diagrams.

WireViz::
A companion web server written in Python (powered by _Flask_ and _Gunicorn_) that provides WireViz.

== Gateway Server

The `yuzutech/kroki` Docker image contains the following diagrams libraries out-of-the-box:
Expand All @@ -47,15 +44,15 @@ The `yuzutech/kroki` Docker image contains the following diagrams libraries out-

|https://github.com/BurntSushi/erd[Erd]
|{erd-version}
//|Binary `/haskell/bin/erd`
//|Binary `/usr/bin/erd`

|https://www.graphviz.org/[GraphViz]
|{graphviz-version}
//|Binary `/usr/bin/dot`

|https://github.com/skanaar/nomnoml[Nomnoml]
|{nomnoml-version}
//|Binary `/node/bin/nomnoml`
//|Binary `/usr/bin/nomnoml`

|https://github.com/blockdiag/nwdiag[NwDiag]
|{nwdiag-version}
Expand All @@ -82,7 +79,7 @@ The `yuzutech/kroki` Docker image contains the following diagrams libraries out-

|https://github.com/ivanceras/svgbob[Svgbob]
|{svgbob-version}
//|Binary `/rust/bin/svgbob`
//|Binary `/usr/bin/svgbob`

|https://hdl.github.io/symbolator/[Symbolator]
|{symbolator-version}
Expand All @@ -94,15 +91,19 @@ The `yuzutech/kroki` Docker image contains the following diagrams libraries out-

|https://github.com/vega/vega[Vega]
|{vega-version}
//|Binary `/node/bin/vega`
//|Binary `/usr/bin/vega`

|https://github.com/vega/vega-lite[Vega-Lite]
|{vegalite-version}
//|Binary `/node/bin/vega`
//|Binary `/usr/bin/vega`

|https://github.com/wavedrom/wavedrom[WaveDrom]
|{wavedrom-version}
//|Binary `/node/bin/wavedrom`
//|Binary `/usr/bin/wavedrom`

|https://github.com/formatc1702/WireViz[WireViz]
|{wireviz-version}
//|Binary `/usr/bin/wireviz`
|===

=== Mermaid
Expand Down Expand Up @@ -148,14 +149,3 @@ The `yuzutech/kroki-diagramsnet` Docker image contains the following diagrams li
|https://www.diagrams.net/[diagrams.net]
|{diagramsnet-version}
|===

=== WireViz

The `yuzutech/kroki-wireviz` Docker image contains the following diagrams libraries out-of-the-box:

[options="header",cols="1,1m"]
|===
|Diagram Type | Version
|https://github.com/formatc1702/WireViz[WireViz]
|{wireviz-version}
|===
12 changes: 0 additions & 12 deletions docs/modules/setup/examples/kroki-docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,15 @@ services:
kroki:
image: yuzutech/kroki
depends_on:
- blockdiag
- mermaid
- bpmn
- excalidraw
environment:
- KROKI_BLOCKDIAG_HOST=blockdiag
- KROKI_MERMAID_HOST=mermaid
- KROKI_BPMN_HOST=bpmn
- KROKI_EXCALIDRAW_HOST=excalidraw
- KROKI_WIREVIZ_HOST=wireviz
ports:
- "8000:8000"
blockdiag:
image: yuzutech/kroki-blockdiag
expose:
- "8001"
mermaid:
image: yuzutech/kroki-mermaid
expose:
Expand All @@ -31,8 +24,3 @@ services:
image: yuzutech/kroki-excalidraw
expose:
- "8004"

wireviz:
image: yuzutech/kroki-wireviz
ports:
- "8006"
2 changes: 0 additions & 2 deletions docs/modules/setup/pages/configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -202,8 +202,6 @@ KROKI_BPMN_HOST:: Host of the BPMN container (default: `127.0.0.1`).
KROKI_BPMN_PORT:: Port of the BPMN container (default: `8003`).
KROKI_EXCALIDRAW_HOST:: Host of the Excalidraw container (default: `127.0.0.1`).
KROKI_EXCALIDRAW_PORT:: Port of the Excalidraw container (default: `8004`).
KROKI_WIREVIZ_HOST:: Host of the WireViz container (default: `127.0.0.1`).
KROKI_WIREVIZ_PORT:: Port of the WireViz container (default: `8006`).

NOTE: If you are using the default `docker-compose.yaml` file you can rely on the default values.

Expand Down
1 change: 0 additions & 1 deletion docs/modules/setup/pages/install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,6 @@ These optional companion containers provide additional diagrams and require the
// * <<yuzutech-kroki-bpmn,Kroki bpmn>>
// * <<yuzutech-kroki-excalidraw,Kroki excalidraw>>
// * <<yuzutech-kroki-mermaid,Kroki mermaid>>
// * <<yuzutech-kroki-wireviz,Kroki wireviz>>

[#yuzutech-kroki-bpmn]
{uri-docker-kroki-bpmn-image}[yuzutech/kroki-bpmn^]::
Expand Down
1 change: 0 additions & 1 deletion docs/modules/setup/pages/use-kubernetes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,6 @@ bpmn-6cfccf9bc4-6w4px 1/1 Running 0 24s
excalidraw-5b84995fcb-dh57t 1/1 Running 0 24s
kroki-6b49bcb7c4-x2ksc 1/1 Running 0 23s
mermaid-7bff5c9959-hkrxx 1/1 Running 0 22s
wireviz-8c778ff7a8-7ds7c 1/1 Running 0 24s
....

. To make sure that Kroki is working, open a terminal and type:
Expand Down

0 comments on commit 7623daf

Please sign in to comment.