INFO:This work has been tried on one node and this application will run on kubernetes master node. If you are going to try this installation on a cluster that has a multiple nodes, you should create the mount folders on your choosen worker node or you can use the storage class(recomended). Also if you choose pv and pvc resources you need to use node selector. I will not give information about node selector here. But, you can find a lot of information about pod assign for node on this link.
Let’s try to this installation.
Step1:
Create Docker user and add in your docker group. Because, we will define id number on yaml file for environment.
useradd docker
useradd -g docker dockerTake your id number of docker users.
id docker
Step2: Create new folder under the worker node. If you have a more than one worker node you must create folder on every each node or you can use node selector to run on specific worker node.
mkdir /opt/bookstack /opt/bookstackdbStep3: Create yaml file for pv and pvc.
vim bokstackpv_pvc.yamlapiVersion: v1
kind: PersistentVolume
metadata:
name: bookstackpv
labels:
type: local
spec:
capacity:
storage: 1Gi
accessModes:
- ReadWriteOnce
hostPath:
path: "/opt/bookstack"
---
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
name: bookstackpvc
spec:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gikubectl create -f bookstackpv_pvc.yamlvim bookstackdbpv_pvc.yamlapiVersion: v1
kind: PersistentVolume
metadata:
name: bookstackdbpv
labels:
type: local
spec:
capacity:
storage: 1Gi
accessModes:
- ReadWriteOnce
hostPath:
path: "/opt/bookstackdb"
---
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
name: bookstackdbpvc
spec:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gikubectl create -f bookstackdbpv_pvc.yamlCheck your pv and pvc resouces.
kubectl get pv
kubectl get pvc
Step4: Create yaml file for database of bookstack.And we will take db pod ip address to use bookstack application yaml file. This is not best practice. If we want to connect the other pod we should create service resources to connect the other pods. Because some pods may die and a new one may up . In this time pod ip address will change. So if we use service, it does not matter even if ip changing because service is matching the pod label.
vim bookstackdb.yamlapiVersion: apps/v1
kind: Deployment
metadata:
name: bookstackdb
labels:
app: bookstackdb
spec:
replicas: 1
selector:
matchLabels:
app: bookstackdb
template:
metadata:
labels:
app: bookstackdb
spec:
containers:
- name: bookstackdb
image: linuxserver/mariadb
ports:
- containerPort: 3306
env:
- name: PUID
value: "1001"
- name: PGID
value: "986"
- name: MYSQL_ROOT_PASSWORD
value: "bookstack"
- name: MYSQL_DATABASE
value: "bookstack"
- name: MYSQL_USER
value: "bookstack"
- name: MYSQL_PASSWORD
value: "bookstack"
- name: TZ
value: "Europe/London"
volumeMounts:
- mountPath: "/config"
name: bokstackdbvolume
volumes:
- name: bokstackdbvolume
persistentVolumeClaim:
claimName: bookstackdbpvckubectl create -f bookstackdb.yamlCheck your first pods with log output.
kubectl get pods
kubectl logs bookstackdb-5d86557d85-p2gdf
Take the ip address from db pods.
kubectl get pods -o wide 
Step5:
Create DB service yaml file to access the database pod.
vim bookstackdb_svc.yamlapiVersion: v1
kind: Service
metadata:
name: bookstackdb
labels:
app: bookstackdb
spec:
ports:
- port: 3306
protocol: TCP
selector:
app: bookstackdbkubectl create -f bookstackdb_svc.yamlStep6:Create bookstack application yaml file with database service name.
vim bookstack.yamlapiVersion: apps/v1
kind: Deployment
metadata:
name: bookstack
labels:
app: bookstack
spec:
replicas: 1
selector:
matchLabels:
app: bookstack
template:
metadata:
labels:
app: bookstack
spec:
containers:
- name: bookstack
image: linuxserver/bookstack
ports:
- containerPort: 80
env:
- name: PUID
value: "1001"
- name: PGID
value: "986"
- name: DB_HOST
value: "bookstackdb"
- name: DB_USER
value: "bookstack"
- name: DB_PASS
value: "bookstack"
- name: DB_DATABASE
value: "bookstack"
volumeMounts:
- mountPath: "/config"
name: bokstackvolume
volumes:
- name: bokstackvolume
persistentVolumeClaim:
claimName: bookstackpvckubectl create -f bookstack.yamlStep7:Create service yaml file to access the your application. I used the service is node port. You can change service type for your system.
vim bookstacksvc.yamlapiVersion: v1
kind: Service
metadata:
name: bookstack
labels:
app: bookstack
spec:
ports:
- port: 80
protocol: TCP
selector:
app: bookstack
type: NodePortkubectl create -f bookstacksvc.yamlList your service and check your node port number. Because we will use tihs port number to access the bookstack application.
kubectl get svc
Step8: Connect to the application with your browser.
Default Login email and password;
Email: admin@admin.com
Password: password
8 Responses
Tüm yaml’ları aynen alarak denememe rağmen bookstack adam akıllı açılmıyor. WorkerNodeIP: şeklinde gittiğimde invalid redirect hatası verirken, WorkerNodeIP:/login şeklinde gittiğimde ise bozuk bir sayfa açılıyor
Merhaba,
Invalid Redirect hatası pod içerisinde /config/www/.env içerisinde APP URL kısmını bağlatı sağlayacağınız IP ile değiştirimeniz yada Ingress tanımı var ise onunla değiştirmeniz yeterli olacaktır. Son güncellemeler ile uygulama tarafında o kısım aktif gelmekte, buna özel configmap oluşturarakta o kısmı düzeltebilirsiniz.
Teşekkürler.
Great explanations ! It works fine !
But here a question :
If your database pod crashes or if you made a rollout on your deployment, your new pod get a new IP address.
So you had to modifiy your bookstack deployment.
Is there any way to fix this issue ?
Regards
Hi,
Before I want to say thank you for your comment. Yes you are right, when your pod is crash, pod ip address will be changed.Yes we can solve this issue. You can write the service name in the deployment yaml file instead of pod ip address. I forget the update this document. Soryy 🙁
Best Regards.
You’re welcome ! When
A tutorial works it is important to say it !
I am a newbie in Kubernetes and I don’t know how to do this…
Could you give me an example or update this document ? I will appreciate it !
Many thanks ! See u
Hi again,
Of course, i will update this document immediately. Sorry my fault, sometimes i do not have enough time.
Best regards.
Hello,
Thanks again for your modifications. Now it works !
In addition of your tutorial I create an ingress in order to access to bookstack with domain.name
It works too.
But I would acccess to bookstack over https and not http… I don’t really how… If your know, please let me know ! 🙂
Under my ingress config file :
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
name: bookstack
namespace: bookstack
annotations:
kubernetes.io/ingress.class: “nginx”
# nginx.ingress.kubernetes.io/rewrite-target: /
spec:
rules:
– host: bookstack.mydomain.com
http:
paths:
– path: /
pathType: Prefix
backend:
service:
name: bookstack
port:
number: 80
Hi Nicolas,
You can follow the “https://hafifbilgiler.com/hafif-bilgiler/kubernetes-and-nexus-repository-integration/” link to define the ingress. If you have certificate, you should create secret with your certificate and your key, if you want to access with selfsigned certificate you can create certificate with “openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout /tmp/tls_key.key -out /tmp/tls_crt.crt -subj “/CN=bookstack-app.your-node-ip.nip.io”” command and you can use the you yaml file. For A lot of information you can follow the the above links and you can change the specific field like hostname and tls. After creation secret and ingress, you should go the inside of container and change the url’s field in the .env file. That’s it you can use the bookstack with tls.