Skip to content
Snippets Groups Projects
Commit fcf9980a authored by Bastien Abadie's avatar Bastien Abadie Committed by Bastien Abadie
Browse files

Migrate howto/on_premise to deployment

parent e8c0ef55
No related branches found
No related tags found
1 merge request!108Document Docker deployment for partners
+++
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,
......@@ -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.
......
......@@ -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).
......
......@@ -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)
+++
title = "Setup"
sort_by = "weight"
weight = 10
+++
File moved
File moved
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment