Skip to content

Commit 4cc749b

Browse files
committed
Fixed misc broken things
1 parent e04870e commit 4cc749b

File tree

7 files changed

+27
-12
lines changed

7 files changed

+27
-12
lines changed

src/content/correctness/tla+.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
[TLA+](https://lamport.azurewebsites.net/tla/tla.html) is a high-level language for modeling distributed and
55
concurrent systems.
66

7-
The Oxia TLA model [OxiaReplication.tla](../../tlaplus/OxiaReplication.tla), contains a model of data replication for a
8-
single shard.
7+
The Oxia TLA model [OxiaReplication.tla](https://github.com/oxia-db/oxia/blob/main/tlaplus/OxiaReplication.tla),
8+
contains a model of data replication for a single shard.
99

1010
The TLA+ tools are able to use this model and explore all the possible states, verifying that the system properties are
1111
not violated (eg: missing entries in the log).

src/content/deployment/_meta.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
export default {
2+
kubernetes: '',
3+
'bare-metal' : '',
4+
}

src/content/deployment/bare-metal.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebarTitle: Bare Metal
3+
---
4+
15
# Deploying in the bare metal
26

37
Suppose you don't have the Kubernetes environment or some container-based system. You can try to deploy Oxia with the bare metal environment.

src/content/deployment/kubernetes.mdx renamed to src/content/deployment/kubernetes/helm.mdx

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebarTitle: Helm
3+
---
4+
15
# Deploying in Kubernetes with Oxia cluster Helm chart
26

37
## Deploying the Oxia cluster
@@ -7,14 +11,14 @@ To deploy the Oxia cluster with Helm:
711
```shell
812
$ kubectl create namespace oxia
913

10-
$ git clone https://github.com/oxia-db/oxia.git
14+
$ git clone https://github.com/oxia-db/helm-charts.git
1115

1216
$ cd oxia
1317

1418
$ helm upgrade --install oxia \
1519
--namespace oxia \
16-
--set image.repository=streamnative/oxia \
17-
--set image.tag=main \
20+
--set image.repository=oxia/oxia \
21+
--set image.tag=latest \
1822
--set image.pullPolicy=IfNotPresent \
1923
deploy/charts/oxia-cluster
2024
```
@@ -29,7 +33,7 @@ The Helm Chart for the Oxia cluster uses a `monitoringEnabled` flag to decide wh
2933
install the service monitor. If you don't have Prometheus installed and don't want to install it, you can set
3034
`monitoringEnabled: false` to skip this part.
3135

32-
Grafana's dashboards are available at [deploy/dashboards](/deploy/dashboards).
36+
Grafana's dashboards are available at [deploy/dashboards](https://github.com/oxia-db/oxia/tree/main/deploy/dashboards).
3337
These can just be imported in your existing Grafana instance.
3438

3539
### Deploying Prometheus Stack

src/content/deployment/kubernetes-oxia-cluster.mdx renamed to src/content/deployment/kubernetes/resources.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
---
2+
sidebarTitle: Resources
3+
---
14

25
# Kubernetes Resources
36

src/content/features/versioning.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,21 +41,21 @@ The versioning is usually used for **Optimistic Concurrency Control (OCC)**. Ins
4141
var result = client.get("a");
4242

4343
// case-1: expect not exists
44-
var result = client.put("a", "a2".getBytes(UTF_8), Set.of(IfRecordDoesNotExist);
44+
var result = client.put("a", "a2".getBytes(), Set.of(IfRecordDoesNotExist);
4545

4646
// case-2: expect by version
47-
var result = client.put("a", "a2".getBytes(UTF_8), Set.of(IfVersionIdEquals(version)));
47+
var result = client.put("a", "a2".getBytes(), Set.of(IfVersionIdEquals(version)));
4848
```
4949
</Tabs.Tab>
5050
<Tabs.Tab>
5151
```python
52-
// read version
52+
# read version
5353
key, value, version = client.get("a")
5454

55-
// case-1: expect not exists
55+
# case-1: expect not exists
5656
key, version = client.put("a", "a2", expected_version_id=oxia.EXPECTED_RECORD_DOES_NOT_EXIST)
5757

58-
// case-2: expect by version
58+
# case-2: expect by version
5959
key, version = client.put("a", "a2", expected_version_id=version.version_id())
6060
```
6161
</Tabs.Tab>

src/content/getting-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import {Steps, Tabs} from 'nextra/components'
77

88
<Tabs items={['Docker', 'Build from Source']}>
99
<Tabs.Tab>
10-
Oxia is available in form of a Docker image: `streamnative/oxia:latest`
10+
Oxia is available in form of a Docker image: `oxia/oxia:latest`
1111
</Tabs.Tab>
1212
<Tabs.Tab>
1313
```shell

0 commit comments

Comments
 (0)