You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/installation.md
+20-20Lines changed: 20 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,20 @@
1
1
# Installation on a k8s cluster
2
2
3
-
This document is a step-by-step guide that describes how to install Docs on a k8s cluster without AI features. It's a teaching document to learn how it's work. It needs to be adapt for production environment.
3
+
This document is a step-by-step guide that describes how to install Docs on a k8s cluster without AI features. It's a teaching document to learn how it works. It needs to be adapted for a production environment.
4
4
5
5
## Prerequisites
6
6
7
7
- k8s cluster with an nginx-ingress controller
8
-
- an OIDC provider (if you don't have one, we will provide an example)
9
-
- a PostgreSQL server (if you don't have one, we will provide an example)
10
-
- a Memcached server (if you don't have one, we will provide an example)
11
-
- a S3 bucket (if you don't have one, we will provide an example)
8
+
- an OIDC provider (if you don't have one, we provide an example)
9
+
- a PostgreSQL server (if you don't have one, we provide an example)
10
+
- a Memcached server (if you don't have one, we provide an example)
11
+
- a S3 bucket (if you don't have one, we provide an example)
12
12
13
13
### Test cluster
14
14
15
-
If you do not have a test cluster, you can install everything on a local kind cluster. In this case, the simplest way is to use our script **bin/start-kind.sh**.
15
+
If you do not have a test cluster, you can install everything on a local Kind cluster. In this case, the simplest way is to use our script **bin/start-kind.sh**.
16
16
17
-
To be able to use the script, you will need to install:
17
+
To be able to use the script, you need to install:
When your k8s cluster is ready (the ingress nginx controller is up), you can start the deployment. This cluster is special because it uses the \*.127.0.0.1.nip.io domain and mkcert certificates to have full HTTPS support and easy domain name management.
99
+
When your k8s cluster is ready (the ingress nginx controller is up), you can start the deployment. This cluster is special because it uses the `*.127.0.0.1.nip.io` domain and mkcert certificates to have full HTTPS support and easy domain name management.
100
100
101
-
Please remember that \*.127.0.0.1.nip.io will always resolve to 127.0.0.1, except in the k8s cluster where we configure CoreDNS to answer with the ingress-nginx service IP.
101
+
Please remember that `*.127.0.0.1.nip.io` will always resolve to `127.0.0.1`, except in the k8s cluster where we configure CoreDNS to answer with the ingress-nginx service IP.
102
102
103
103
## Preparation
104
104
105
-
### What will you use to authenticate your users?
105
+
### What do you use to authenticate your users?
106
106
107
107
Docs uses OIDC, so if you already have an OIDC provider, obtain the necessary information to use it. In the next step, we will see how to configure Django (and thus Docs) to use it. If you do not have a provider, we will show you how to deploy a local Keycloak instance (this is not a production deployment, just a demo).
Impress uses a postgresql db as backend so if you have a provider, obtain the necessary information to use it. If you do not have, you can install a postgresql testing environment as follow:
151
+
Docs uses a postgresql database as backend, so if you have a provider, obtain the necessary information to use it. If you don't, you can install a postgresql testing environment as follow:
From here important informations you will need are:
163
+
From here the important information you will need are:
164
164
165
-
```
165
+
```yaml
166
166
DB_HOST: postgres-postgresql
167
167
DB_NAME: impress
168
168
DB_USER: dinum
@@ -175,7 +175,7 @@ POSTGRES_PASSWORD: pass
175
175
176
176
### Find s3 bucket connexion values
177
177
178
-
Impress uses a s3 bucket to store documents so if you have a provider obtain the necessary information to use it. If you do not have, you can install a local minio testing environment as follow:
178
+
Docs uses an s3 bucket to store documents, so if you have a provider obtain the necessary information to use it. If you don't, you can install a local minio testing environment as follow:
Now you are ready to deploy Impress without AI. AI requiered more dependancies (openai API). To deploy impress you need to provide all previous informations to the helm chart.
194
+
Now you are ready to deploy Docs without AI. AI requires more dependencies (OpenAI API). To deploy Docs you need to provide all previous informations to the helm chart.
0 commit comments