From e29abfa40a2bb193c4dba5ff3e7eaf9b7659f0bb Mon Sep 17 00:00:00 2001
From: Bastien Abadie <bastien@nextcairn.com>
Date: Wed, 10 Apr 2024 11:06:55 +0200
Subject: [PATCH] Migrate howto/on_premise to deployment
---
content/deployment/_index.md | 12 ++++++++++++
.../on_premise => deployment}/architecture.mermaid | 0
.../on_premise => deployment}/architecture.png | Bin
.../on_premise => deployment}/configuration.md | 3 +--
.../on_premise => deployment}/docker_compose.md | 7 +++----
.../on_premise/index.md => deployment/old.md} | 6 +++---
content/deployment/setup.md | 5 +++++
content/{howto/on_premise => deployment}/stack.png | Bin
.../on_premise => deployment}/workers.mermaid | 0
.../{howto/on_premise => deployment}/workers.png | Bin
10 files changed, 24 insertions(+), 9 deletions(-)
create mode 100644 content/deployment/_index.md
rename content/{howto/on_premise => deployment}/architecture.mermaid (100%)
rename content/{howto/on_premise => deployment}/architecture.png (100%)
rename content/{howto/on_premise => deployment}/configuration.md (99%)
rename content/{howto/on_premise => deployment}/docker_compose.md (96%)
rename content/{howto/on_premise/index.md => deployment/old.md} (91%)
create mode 100644 content/deployment/setup.md
rename content/{howto/on_premise => deployment}/stack.png (100%)
rename content/{howto/on_premise => deployment}/workers.mermaid (100%)
rename content/{howto/on_premise => deployment}/workers.png (100%)
diff --git a/content/deployment/_index.md b/content/deployment/_index.md
new file mode 100644
index 00000000..e0cae793
--- /dev/null
+++ b/content/deployment/_index.md
@@ -0,0 +1,12 @@
++++
+title = "Deployment"
+sort_by = "weight"
+weight = 90
+insert_anchor_links = "right"
++++
+
+This documentation is aimed at system administrators and business leaders who want to deploy the Arkindex platform on their own hardware.
+
+In this section you'll find out how to:
+
+1. setup [Arkindex](@/deployment/setup.md), in production mode,
diff --git a/content/howto/on_premise/architecture.mermaid b/content/deployment/architecture.mermaid
similarity index 100%
rename from content/howto/on_premise/architecture.mermaid
rename to content/deployment/architecture.mermaid
diff --git a/content/howto/on_premise/architecture.png b/content/deployment/architecture.png
similarity index 100%
rename from content/howto/on_premise/architecture.png
rename to content/deployment/architecture.png
diff --git a/content/howto/on_premise/configuration.md b/content/deployment/configuration.md
similarity index 99%
rename from content/howto/on_premise/configuration.md
rename to content/deployment/configuration.md
index ed537658..381a9bc0 100644
--- a/content/howto/on_premise/configuration.md
+++ b/content/deployment/configuration.md
@@ -2,8 +2,7 @@
title = "Configure Arkindex backend"
description = "All the configuration options available to setup your Arkindex backend"
-# Clean slug for parent folder
-path = "howto/on-premise/configuration/"
+weight = 30
+++
You will find on this page all the configuration settings available for the Arkindex backend. These settings must be stored in a YAML file, and exposed using a Docker volume to the backend and worker container. The configuration path is set through `CONFIG_PATH` environment variable.
diff --git a/content/howto/on_premise/docker_compose.md b/content/deployment/docker_compose.md
similarity index 96%
rename from content/howto/on_premise/docker_compose.md
rename to content/deployment/docker_compose.md
index 92f89c50..40024903 100644
--- a/content/howto/on_premise/docker_compose.md
+++ b/content/deployment/docker_compose.md
@@ -2,8 +2,7 @@
title = "Deploy Arkindex with docker-compose"
description = "Deploy Arkindex on your own infrastucture using Linux and docker-compose"
-# Clean slug for parent folder
-path = "howto/on-premise/docker-compose/"
+weight = 10
+++
This documentation is written for **system administrators**.
@@ -50,7 +49,7 @@ Teklia will provide you with several docker images (to load using [docker load](
- the tasks image, `registry.gitlab.teklia.com/arkindex/tasks:X.Y.Z`, will be used to by the remote workers (file imports, thumbnails generation, ...).
- the ponos image, `registry.gitlab.teklia.com/arkindex/ponos-agent:X.Y.Z` will be used to actually run the asynchronous tasks across all your remote workers.
-
-{{ figure(image="howto/on_premise/stack.png", height=250, caption="Arkindex Platform and a single Worker") }}
+{{ figure(image="deployment/stack.png", height=250, caption="Arkindex Platform and a single Worker") }}
The backend image mentioned above will run in two containers on your application server:
1. for the API, this is really the heart of Arkindex,
@@ -67,7 +66,7 @@ Of course your setup may differ, you could use external services (databases, sea
### Configuration
-All the configuration options for the backend are detailed [on this page](@/howto/on_premise/configuration.md).
+All the configuration options for the backend are detailed [on this page](@/deployment/configuration.md).
A minimal configuration file is also available in the [public repository](https://gitlab.teklia.com/arkindex/public-architecture/-/blob/master/config.yml).
diff --git a/content/howto/on_premise/index.md b/content/deployment/old.md
similarity index 91%
rename from content/howto/on_premise/index.md
rename to content/deployment/old.md
index b5be39dd..2e16192b 100644
--- a/content/howto/on_premise/index.md
+++ b/content/deployment/old.md
@@ -14,7 +14,7 @@ In the following sections, we'll describe the requirements needed to run an effi
The main part of the architecture uses a set of open-source software along with our own proprietary software.
-{{ figure(image="howto/on_premise/architecture.png", height=400, caption="Arkindex platform architecture") }}
+{{ figure(image="deployment/architecture.png", height=400, caption="Arkindex platform architecture") }}
The open source components here are:
- Traefik as load balancer,
@@ -26,7 +26,7 @@ The open source components here are:
You'll also need to run a set of workers on dedicated servers: this is where the Machine Learning processes will run.
-{{ figure(image="howto/on_premise/workers.png", height=400, caption="Arkindex workers for Machine Learning") }}
+{{ figure(image="deployment/workers.png", height=400, caption="Arkindex workers for Machine Learning") }}
Each worker in the diagram represents a dedicated server, running our in-house job scheduling agents and dedicated Machine Learning tasks.
@@ -98,4 +98,4 @@ We can also provide a private instance that we manage on our servers (hosted in
## Run with docker
-More information on [running Arkindex using docker-compose](@/howto/on_premise/docker_compose.md)
+More information on [running Arkindex using docker-compose](@/deployment/docker_compose.md)
diff --git a/content/deployment/setup.md b/content/deployment/setup.md
new file mode 100644
index 00000000..403c4f76
--- /dev/null
+++ b/content/deployment/setup.md
@@ -0,0 +1,5 @@
++++
+title = "Setup"
+sort_by = "weight"
+weight = 10
++++
diff --git a/content/howto/on_premise/stack.png b/content/deployment/stack.png
similarity index 100%
rename from content/howto/on_premise/stack.png
rename to content/deployment/stack.png
diff --git a/content/howto/on_premise/workers.mermaid b/content/deployment/workers.mermaid
similarity index 100%
rename from content/howto/on_premise/workers.mermaid
rename to content/deployment/workers.mermaid
diff --git a/content/howto/on_premise/workers.png b/content/deployment/workers.png
similarity index 100%
rename from content/howto/on_premise/workers.png
rename to content/deployment/workers.png
--
GitLab