Skip to content

Commit 2815e71

Browse files
nikita-vanyasinnikita-vanyasin
authored
Improve documentation rendering for GitHub Pages (#1558)
1 parent 833d890 commit 2815e71

File tree

94 files changed

+570
-141
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+570
-141
lines changed

‎CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Change Log
22

33
## [master](https://github.com/arangodb/kube-arangodb/tree/master) (N/A)
4+
- (Documentation) Improve documentation rendering for GitHub Pages
45

56
## [1.2.36](https://github.com/arangodb/kube-arangodb/tree/1.2.36) (2024-01-08)
67
- (Documentation) Improvements and fixes for rendered documentation (GH pages)

‎README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,29 @@
22

33
[![Docker Pulls](https://img.shields.io/docker/pulls/arangodb/kube-arangodb.svg)](https://hub.docker.com/r/arangodb/kube-arangodb/)
44

5-
ArangoDB Kubernetes Operator helps to run ArangoDB deployments
6-
on Kubernetes clusters.
5+
The ArangoDB Kubernetes Operator (`kube-arangodb`) is a set of operators
6+
that you deploy in your Kubernetes cluster to:
7+
- Manage deployments of the [ArangoDB database](https://arangodb.com/)
8+
- Manage backups
9+
- Provide `PersistentVolumes` on local storage of your nodes for optimal storage performance.
10+
- Configure ArangoDB Datacenter-to-Datacenter Replication
11+
12+
Each of these uses involves a different custom resource:
13+
- Use an [ArangoDeployment resource](docs/deployment-resource-reference.md) to create an ArangoDB database deployment.
14+
- Use an [ArangoMember resource](docs/api/ArangoMember.V1.md) to observe and adjust individual deployment members.
15+
- Use an [ArangoBackup](docs/backup-resource.md) and [ArangoBackupPolicy](docs/backuppolicy-resource.md) resources to create ArangoDB backups.
16+
- Use an [ArangoLocalStorage resource](docs/storage-resource.md) to provide local `PersistentVolumes` for optimal I/O performance.
17+
- Use an [ArangoDeploymentReplication resource](docs/deployment-replication-resource-reference.md) to configure ArangoDB Datacenter-to-Datacenter Replication.
18+
19+
Continue with [Using the ArangoDB Kubernetes Operator](docs/using-the-operator.md)
20+
to learn how to install the ArangoDB Kubernetes operator and create your first deployment.
721

8-
To get started, follow the Installation instructions below and/or
9-
read the [tutorial](docs/using-the-operator.md).
1022

1123
## State
1224

1325
The ArangoDB Kubernetes Operator is Production ready.
1426

15-
[Documentation](docs/README.md)
27+
[Documentation](https://arangodb.github.io/kube-arangodb/)
1628

1729
### Limits
1830

‎docs/README.md

Lines changed: 0 additions & 56 deletions
This file was deleted.

‎docs/api/ArangoBackup.V1.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
parent: CRD reference
4+
title: ArangoBackup V1
5+
---
6+
17
# API Reference for ArangoBackup V1
28

39
## Spec

‎docs/api/ArangoBackupPolicy.V1.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
parent: CRD reference
4+
title: ArangoBackupPolicy V1
5+
---
6+
17
# API Reference for ArangoBackupPolicy V1
28

39
## Spec

‎docs/api/ArangoDeployment.V1.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
parent: CRD reference
4+
title: ArangoDeployment V1
5+
---
6+
17
# API Reference for ArangoDeployment V1
28

39
## Spec

‎docs/api/ArangoDeploymentReplication.V1.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
parent: CRD reference
4+
title: ArangoDeploymentReplication V1
5+
---
6+
17
# API Reference for ArangoDeploymentReplication V1
28

39
## Spec

‎docs/api/ArangoLocalStorage.V1Alpha.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
parent: CRD reference
4+
title: ArangoLocalStorage V1Alpha
5+
---
6+
17
# API Reference for ArangoLocalStorage V1Alpha
28

39
## Spec

‎docs/api/ArangoMLBatchJob.V1Alpha1.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
parent: CRD reference
4+
title: ArangoMLBatchJob V1Alpha1
5+
---
6+
17
# API Reference for ArangoMLBatchJob V1Alpha1
28

39
## Spec

‎docs/api/ArangoMLCronJob.V1Alpha1.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
parent: CRD reference
4+
title: ArangoMLCronJob V1Alpha1
5+
---
6+
17
# API Reference for ArangoMLCronJob V1Alpha1
28

39
## Spec

‎docs/api/ArangoMLExtension.V1Alpha1.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
parent: CRD reference
4+
title: ArangoMLExtension V1Alpha1
5+
---
6+
17
# API Reference for ArangoMLExtension V1Alpha1
28

39
## Spec

‎docs/api/ArangoMLStorage.V1Alpha1.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
parent: CRD reference
4+
title: ArangoMLStorage V1Alpha1
5+
---
6+
17
# API Reference for ArangoMLStorage V1Alpha1
28

39
## Spec

‎docs/api/ArangoMember.V1.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
parent: CRD reference
4+
title: ArangoMember V1
5+
---
6+
17
# API Reference for ArangoMember V1
28

39
## Spec

‎docs/api/README.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
1-
# Custom Resources API Reference
2-
3-
- [ArangoBackup.V1](./ArangoBackup.V1.md)
4-
- [ArangoBackupPolicy.V1](./ArangoBackupPolicy.V1.md)
5-
- [ArangoDeployment.V1](./ArangoDeployment.V1.md)
6-
- [ArangoDeploymentReplication.V1](./ArangoDeploymentReplication.V1.md)
7-
- [ArangoLocalStorage.V1Alpha](./ArangoLocalStorage.V1Alpha.md)
8-
- [ArangoMLBatchJob.V1Alpha1](./ArangoMLBatchJob.V1Alpha1.md)
9-
- [ArangoMLCronJob.V1Alpha1](./ArangoMLCronJob.V1Alpha1.md)
10-
- [ArangoMLExtension.V1Alpha1](./ArangoMLExtension.V1Alpha1.md)
11-
- [ArangoMLStorage.V1Alpha1](./ArangoMLStorage.V1Alpha1.md)
12-
- [ArangoMember.V1](./ArangoMember.V1.md)
13-
1+
---
2+
layout: page
3+
title: CRD reference
4+
has_children: true
5+
nav_order: 3
6+
---

‎docs/backup-resource.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
parent: Custom resources overview
4+
title: ArangoBackup
5+
---
6+
17
# ArangoBackup Custom Resource
28

39
[Full CustomResourceDefinition reference ->](./api/ArangoBackup.V1.md)

‎docs/backuppolicy-resource.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
parent: Custom resources overview
4+
title: ArangoBackupPolicy
5+
---
6+
17
# ArangoBackupPolicy Custom Resource
28

39
[Full CustomResourceDefinition reference ->](./api/ArangoBackupPolicy.V1.md)

‎docs/crds.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
---
2+
layout: page
3+
has_children: true
4+
title: Custom resources overview
5+
nav_order: 4
6+
has_toc: false
7+
---
8+
19
# Custom resources overview
210

311
Main CRDs:

‎docs/dashboards.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
nav_order: 20
4+
title: Operator dashboard
5+
---
6+
17
# Deployment Operator Dashboards
28

39
### Dashboard UI now is deprecated and will be removed in next minor version

‎docs/deployment-replication-resource-reference.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
parent: Custom resources overview
4+
title: ArangoDeploymentReplication
5+
---
6+
17
# ArangoDeploymentReplication Custom Resource
28

39
#### Enterprise Edition only
@@ -90,10 +96,12 @@ running in Kubernetes:
9096

9197
2. Extract the access package from the source ArangoDB cluster.
9298

99+
<!-- {% raw %} -->
93100
```bash
94101
kubectl get secret src-accesspackage --template='{{index .data "accessPackage.yaml"}}' | \
95102
base64 -D > accessPackage.yaml
96103
```
104+
<!-- {% endraw %} -->
97105

98106
3. Configure the source DNS names.
99107

@@ -232,9 +240,12 @@ The process for creating and using an access package for authentication at the s
232240
- Wait for the `ArangoDeployment` operator to create a `Secret` named `my-access-package`.
233241
- Extract the access package from the Kubernetes source cluster using:
234242

243+
244+
<!-- {% raw %} -->
235245
```bash
236246
kubectl get secret my-access-package --template='{{index .data "accessPackage.yaml"}}' | base64 -D > accessPackage.yaml
237247
```
248+
<!-- {% endraw %} -->
238249

239250
- Insert the secrets found in the access package in the Kubernetes destination cluster using:
240251

‎docs/deployment-resource-reference.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
parent: Custom resources overview
4+
title: ArangoDeployment
5+
---
6+
17
# ArangoDeployment Custom Resource Overview
28

39
[Full CustomResourceDefinition reference ->](./api/ArangoDeployment.V1.md)

‎docs/design/README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
1-
# ArangoDB operator architecture overview
1+
---
2+
layout: page
3+
title: Design overview
4+
has_children: true
5+
nav_order: 5
6+
---
27

3-
- [Operator API](./api.md)
4-
- [Backups](./backup.md)
5-
- [Constraints for high-availability](./constraints.md)
6-
- [ArangoDB Exporter](./exporter.md)
7-
- [Health](./health.md)
8-
- [Lifecycle hooks and Finalizers](./lifecycle_hooks_and_finalizers.md)
9-
- [Pod eviction and replacement](./pod_eviction_and_replacement.md)
10-
- [Kubernetes Pod name versus cluster ID](./pod_name_versus_cluster_id.md)
11-
- [Resources & labels](./resources_and_labels.md)
12-
- [Topology awareness](./topology_awareness.md)

‎docs/design/api.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
title: Operator API
4+
parent: Design overview
5+
---
6+
17
# Operator API
28

39
A running operator exposes HTTP and gRPC API listeners to allow retrieving and setting some configuration values programmatically.

‎docs/design/backup.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
title: Backups
4+
parent: Design overview
5+
---
6+
17
# ArangoBackup
28

39
## Lifetime

‎docs/design/constraints.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
title: Constraints
4+
parent: Design overview
5+
---
6+
17
# Constraints
28

39
The ArangoDB operator tries to honor various constraints to support high availability of

‎docs/design/exporter.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
title: ArangoDB Metrics
4+
parent: Design overview
5+
---
6+
17
# ArangoDB Exporter for Prometheus
28

39
This exporter exposes the statistics provided by a specific ArangoDB instance

‎docs/design/health.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
title: Health checks
4+
parent: Design overview
5+
---
6+
17
# Health checks
28

39
## Liveness Probe

‎docs/design/lifecycle_hooks_and_finalizers.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
title: Lifecycle hooks and Finalizers
4+
parent: Design overview
5+
---
6+
17
# Lifecycle hooks & Finalizers
28

39
The ArangoDB operator expects full control of the `Pods` and `PersistentVolumeClaims` it creates.

‎docs/design/pod_eviction_and_replacement.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: page
3+
title: Pod eviction and replacement
4+
parent: Design overview
5+
---
6+
17
# Pod Eviction & Replacement
28

39
This chapter specifies the rules around evicting pods from nodes and

0 commit comments

Comments
 (0)