Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 76 additions & 45 deletions .github/styles/config/vocabularies/docs/accept.txt
Original file line number Diff line number Diff line change
@@ -1,45 +1,76 @@
(?i)Rhize
(?i)bpmn
(?i)gzip
APIs
Appsmith
Bitnami
Dockerfile
Grafana
JSONata
JWT
JWTs
JetStream
KPI
KPIs
Keycloak
Mapbox
NATS
Preact
URI
URIs
[Aa]ctuals
[Bb]oolean
[Dd]atasource
[Dd]eduplication
[Dd]graph
[Ee]num
[Ll]ibre
[Pp]ostgres
[Uu]psert
andon
autoscale
bigFigure
config
explorable
hostname
namespace
param
performant
relref
subgraph
supergraph
swappable
unaccepted
unencrypted
unpackaged
(?i)Rhize
(?i)bpmn
(?i)gzip
APIs
Appsmith
Bitnami
Dockerfile
Grafana
JSONata
jsonata
JWT
JWTs
JetStream
KPI
KPIs
Keycloak
Mapbox
NATS
Preact
URI
URIs
[Aa]ctuals
[Bb]oolean
[Dd]atasource
[Dd]eduplication
[Dd]graph
[Ee]num
[Ll]ibre
[Pp]ostgres
[Uu]psert
andon
autoscale
bigFigure
config
explorable
hostname
namespace
namespaces
param
performant
relref
subgraph
supergraph
swappable
unaccepted
unencrypted
unpackaged
[Ss]eeq
[Ss]copemap
Youtube
libreBaas
BAAS's
MBps
audit_log
backoff
idempotency
[Dd]eduplicated
subtab
mkdir
mv
repo
[Rr]edpanda
timeseries
sbustitude
[Oo]verfetch
autoscales
mdh
toolkits
operationEvent
composable
UIs
subproperties
url
Comment thread
Jwilson2000 marked this conversation as resolved.
URL
URLs
configs
54 changes: 27 additions & 27 deletions .github/workflows/pr-previews.yaml
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
name: Check PR
on:
pull_request:
types:
- opened
- reopened
- synchronize
- closed

jobs:
vale:
name: runner / vale
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: errata-ai/vale-action@reviewdog
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
with:
reporter: github-check
fail_on_error: true
level: warning
debug: true
separator: ","
files: >-
content/deploy/,content/get-started/,content/how-to/,content/reference/
vale_flags: '--glob=*.md'
name: Check PR
on:
pull_request:
types:
- opened
- reopened
- synchronize
- closed
jobs:
vale:
name: runner / vale
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: errata-ai/vale-action@reviewdog
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
with:
reporter: github-check
fail_on_error: true
level: warning
debug: true
separator: ","
files: >-
content/latest/deploy/,content/get-started/,content/latest/how-to/,content/latest/reference/
vale_flags: '--glob=*.md'
42 changes: 21 additions & 21 deletions .github/workflows/prose-lint.yaml
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
name: reviewdog
on: push

jobs:
vale:
name: runner / vale
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: errata-ai/vale-action@reviewdog
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
with:
reporter: github-check
fail_on_error: false
level: warning
debug: true
separator: ","
files: >-
content/deploy/,content/get-started/,content/how-to/,content/reference/
vale_flags: '--glob=*.md'
name: reviewdog
on: push
jobs:
vale:
name: runner / vale
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: errata-ai/vale-action@reviewdog
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
with:
reporter: github-check
fail_on_error: false
level: warning
debug: true
separator: ","
files: >-
content/latest/deploy/,content/get-started/,content/latest/how-to/,content/latest/reference/
vale_flags: '--glob=*.md'
2 changes: 1 addition & 1 deletion content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description: User guides, deploy docs, references, and deep dives about the
Rhize manufacturing data hub.
cascade:
v: "4.2.0"
v: "4.3.0"
type: "docs"
---

Expand Down
2 changes: 1 addition & 1 deletion content/latest/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ weight: 002
description: User guides, deploy docs, references, and deep dives about the
Rhize manufacturing data hub.
cascade:
v: "4.2.0"
v: "4.3.0"
type: "docs"
icon: molecule

Expand Down
42 changes: 37 additions & 5 deletions content/latest/deploy/backup/graphdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,11 @@ Before you start, ensure you have the following:
{{% param pre_reqs %}}.


Before you start, confirm you are in the right context and namespace:
Before you start, check the following:

{{% param "k8s_cluster_ns" %}}
1. Confirm you are in the right context and namespace:

## Steps

To back up the database, follow these steps:
{{% param "k8s_cluster_ns" %}}

1. Check the logs for the alpha and zero pods, either in Lens or with [`kubectl logs`](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#logs).
Ensure there are no errors.
Expand All @@ -46,6 +44,36 @@ To back up the database, follow these steps:

For details, read the Kubernetes topic [Get Shell to a Running Container](https://kubernetes.io/docs/tasks/debug/debug-application/get-shell-running-container/).

## Steps

To back up the database, you need to first trigger a backup, and then retrieve the backup using `kubectl`.

### Backup

To back up the database, you can use either of the following methods:

#### BAAS Console

This method uses the BAAS web console to trigger a backup.

1. Navigate to `<baas-url>/console` in your browser of choice.

1. Log in to the BAAS Console with your Keycloak credentials.

1. Click **Backups > Local Export**.

{{< callout type="info" >}}
Database backups support S3/Minio and includes an option to list backups in a specific destination. For this guide we will be performing a local backup.
{{< /callout >}}

1. Enter your designated backup location along with the backup name, or use the default provided.

1. Click **Start Export** and wait for the operation to finish. A dialogue should appear saying **Export Completed Successfully**.

#### Alpha Pod Shell

This option uses the shell opened in the prerequisites to trigger a backup.

1. Make a POST request to your Keycloak `/token` endpoint to get an `access_token` value.
For example, with `curl` and `jq`:

Expand Down Expand Up @@ -73,6 +101,10 @@ For example, with `curl`:
--data-raw '{"query":"mutation {\r\n export(input: {format: \"json\", destination: \"/dgraph/backups/'"$(date +"%Y-%m-%dT%H.%M.%SZ")"'\"}) {\r\n response {\r\n message\r\n code\r\n }\r\n}\r\n}","variables":{}}'
```

### Retrieve

To retrieve the backup, we will need to use the alpha pod shell opened in the prerequisites.

1. Change to the backup directory (the `destination` parameter in the preceding `curl` command). For example:

```bash
Expand Down
4 changes: 2 additions & 2 deletions content/latest/deploy/install/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ Install Typescript Host Service with these steps:

### QuestDB

QuestDB is used by Rhize to store timeseries data, however it can be substitude for another historian.
QuestDB is used by Rhize to store timeseries data, however it can be substitute for another historian.

Install QuestDB with these steps:

Expand Down Expand Up @@ -427,7 +427,7 @@ alpha:

### KPI

The Rhize KPI service is a GraphQL service which calcualtes ISO22400 KPIs using timseries tables.
The Rhize KPI service is a GraphQL service which calculates ISO22400 KPIs using timeseries tables.

Install KPI with these steps:

Expand Down
4 changes: 4 additions & 0 deletions content/latest/deploy/install/setup-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,10 @@ Then, follow these steps.
helm install keycloak -f ./keycloak.yaml bitnami/keycloak -n {{< param application_name >}}
```

{{< callout type="warning" >}}
As of Augest 28th, 2026, Bitnami has migrated many of their container images from the public catalog to the **Bitnami Legacy** repository. While Bitnami's helm charts can be used, users should ensure that their keycloak values file has `bitnamilegacy/keycloak` as the repository for the container image.
{{< /callout >}}

1. Set up port forwarding from Keycloak. For example, this forwards traffic to port `5101` on `localhost`:

```bash
Expand Down
42 changes: 2 additions & 40 deletions content/latest/deploy/restore/graphdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,44 +97,6 @@ Before you start, ensure you have the following:

1. Wait for `{{< param application_name >}}-baas-alpha-0` to start serving the GraphQL API.

1. Make a database mutation to force a snapshot to be taken.
For example, create a `UnitOfMeasure` then delete it:
1. Repeat the process, starting from step 4, for each Alpha replica.

```bash
kubectl exec -t {{< param application_name >}}-baas-alpha-0 -c {{< param application_name >}}-baas-alpha -- \
curl --location --request POST 'http://localhost:8080/graphql' \
--header 'Content-Type: application/json' \
--data-raw '{"query":"mutation RestoringDatabase($input:[AddUnitOfMeasureInput!]!){\r\n addUnitOfMeasure(input:$input){\r\n unitOfMeasure{\r\n id\r\n dataType\r\n code\r\n }\r\n}\r\n}","variables":{"input":[{"code":"Restoring","isActive":true,"dataType":"BOOL"}]}}'
```
Wait until you see {{< param application_name >}}-baas creating a snapshot in the logs. For example:

```bash
$ kubectl logs {{< param application_name >}}-baas-alpha-0
++ hostname -f
++ awk '{gsub(/\.$/,""); print $0}'
...
I0314 20:32:21.282271 19 draft.go:805] Creating snapshot at Index: 16, ReadTs: 9
```

Revert any database mutations:

```bash
kubectl exec -t {{< param application_name >}}-baas-alpha-0 -c {{< param application_name >}}-baas-alpha -- \
curl --location --request POST 'http://localhost:8080/graphql' \
--header 'Content-Type: application/json' \
--data-raw '{"query":"mutation {\r\n deleteUnitOfMeasure(filter:{code:{eq:\"Restoring\"}}){\r\n unitOfMeasure{\r\n id\r\n }\r\n }\r\n}","variables":{"input":[{"code":"Restoring","isActive":true,"dataType":"BOOL"}]}}'
```

1. Complete the initialization container for alpha 1:

```bash
kubectl exec -t {{< param application_name >}}-baas-alpha-1 -c {{< param application_name >}}-baas-alpha-init -- \
touch /dgraph/doneinit
```

And alpha 2:

```bash
kubectl exec -t {{< param application_name >}}-baas-alpha-2 -c {{< param application_name >}}-baas-alpha-init -- \
touch /dgraph/doneinit
```
In each step, replace `{{< param application_name >}}-baas-alpha-0` with `{{< param application_name >}}-baas-alpha-<REPLICA-NUMBER>`, where `<REPLICA-NUMBER>` is the current Alpha replica being restored.
2 changes: 1 addition & 1 deletion content/latest/how-to/seeq.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
- `operations-schedule:query`
- `operations-performance:query`

Roles can be filted to only show **libreBaas** roles by using the search.
Roles can be filtered to only show **libreBaas** roles by using the search.
6. Select the **Credentials** tab and copy the **Client secret**.

> The Client ID and Client Secret are both necessary for authenticating the Rhize Connector.
Expand All @@ -75,8 +75,8 @@
### Standard Rhize Additional Configuration
| Property Name | Default Value | Data Type | Description |
|:---|:---|:---|:---|
| ApiUrl | null | String | The url to Rhize's backend. |

Check failure on line 78 in content/latest/how-to/seeq.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/latest/how-to/seeq.md#L78

[Vale.Terms] Use 'URL' instead of 'url'.
Raw output
{"message": "[Vale.Terms] Use 'URL' instead of 'url'.", "location": {"path": "content/latest/how-to/seeq.md", "range": {"start": {"line": 78, "column": 32}}}, "severity": "ERROR"}
| AuthUrl | null | String | The url to Keycloak. |

Check failure on line 79 in content/latest/how-to/seeq.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/latest/how-to/seeq.md#L79

[Vale.Terms] Use 'URL' instead of 'url'.
Raw output
{"message": "[Vale.Terms] Use 'URL' instead of 'url'.", "location": {"path": "content/latest/how-to/seeq.md", "range": {"start": {"line": 79, "column": 33}}}, "severity": "ERROR"}
| ClientId | null | String | The ID for the configured Seeq client. |
| ClientSecret | null | String | The secret for the configured Seeq client. |
| Realm | null | String | The realm for Rhize's Keycloak configuration. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Rhize agent collects data that is emitted in the manufacturing process and m
It works by connecting to equipment or groups of equipment that run over protocols such as OPC UA.

As the communication bridge between the Rhize Data Hub and your plant, the agent has multiple functions:
- It subscribes to tags and republishes the changes in the messsage broker.
- It subscribes to tags and republishes the changes in the message broker.
- It creates an interface for the BPMN engine to send reads and writes to a data source and its associated equipment.


Expand Down
Loading
Loading