Changes for page XWiki (Helm)

Last modified by Itzhak Daniel on 2024/04/29 16:35

From 13.1 to 14.1 From 21.1 to 22.1

From version 14.1

edited by Itzhak Daniel
on 2024/04/29 00:25

Change comment: Uploaded new attachment "values.yaml", version 1.1

To version 21.1

edited by Itzhak Daniel
on 2024/04/29 01:50

Change comment: Uploaded new attachment "values.yaml", version 1.2

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (2 modified, 0 added, 0 removed)
- Dockerfile
- values.yaml

Details

Page properties

Content

@@ -12,7 +12,7 @@
  == Background ==
--[[Behemoth LTD>>https://www.behemoth.co.il/]] was in a search for a 'knowledge base' software, a central place to collect and collaborate on documents which hold information, instructions, guide, etc. The requirement was simple, it required to be able to run on Kubernetes without too much customization, building, testing and other complex CI/CD prerequisite.
++[[Behemoth LTD>>https://www.behemoth.co.il/]] was in a search for a 'knowledge base' software, a central place to collect and collaborate on documents which hold information, instructions, guides, etc. The requirement was simple, can run on Kubernetes without too much customization, building, testing and other complex CI/CD prerequisite.
  Things may change in the future, as Kubernetes becomes the de-facto way to run Apps, so do some homework before continuing, [[Awesome Selfhosted>>https://github.com/awesome-selfhosted/awesome-selfhosted#wikis]].
@@ -41,7 +41,7 @@
  At the beginning we tried to avoid making any custom changes to the images in question (XWiki and Bitnami's MySQL). But XWiki running as root, didn't fly. So we had to create a custom image with minor changes to enable it to run as a unprivileged uid/gid: 30001.
--=== Building and Publish ===
++=== Build and Publish ===
  You will need to perform the following actions:
@@ -49,7 +49,7 @@
  git clone --depth 1 --branch master https://github.com/xwiki/xwiki-docker.git
  {{/code}}
--Once you have the repo locally, modify the //Dockerfile// as shown below:
++Once you have the repo locally, modify the [[//Dockerfile//>>attach:Dockerfile]] as shown below:
  {{code language="git" title="# Diff"}}
@@ -89,6 +89,11 @@ COPY xwiki/docker-entrypoint.sh /usr/local/bin/docker-entrypoint.sh
@@ -71,15 +71,15 @@
  {{code language="sh" layout="LINENUMBERS" title="# Docker"}}
  cd ./16/mysql-tomcat/
--docker build -t behemothil/xwiki-mysql-tomcat-nonroot:16.2.0-2 .
++docker build -t behemothil/xwiki-mysql-tomcat-nonroot:16.2.0-3 .
  docker login
--docker push behemothil/xwiki-mysql-tomcat-nonroot:16.2.0-2
++docker push behemothil/xwiki-mysql-tomcat-nonroot:16.2.0-3
  {{/code}}
  {{code language="sh" layout="LINENUMBERS" title="# Podman"}}
  cd ./16/mysql-tomcat/
--buildah build -f Dockerfile -t behemothil/xwiki-mysql-tomcat-nonroot:16.2.0-2
--docker push --creds=[Username:[Password]] behemothil/xwiki-mysql-tomcat-nonroot:16.2.0-2
++buildah build -f Dockerfile -t behemothil/xwiki-mysql-tomcat-nonroot:16.2.0-3
++podman push --creds=[Username:[Password]] behemothil/xwiki-mysql-tomcat-nonroot:16.2.0-3
  {{/code}}
  === Deploy ===
@@ -86,7 +86,7 @@
  We're going to deploy XWiki as a [[statefulset>>https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/]] using [[Helm>>https://helm.sh/]], the Database (MySQL) and the App, each will have a volume to store their information. As I mentioned, in our case, we need to perform several additional steps.
--After the path/loop devices were created, create the PVs (only if your cluster doesn't know how to provision storage for itself):
++After the path/loop devices were created, create the [[PVs>>attach:pv_storage.yaml]] (only if your cluster doesn't know how to provision storage for itself):
  {{code language="sh" layout="LINENUMBERS" title="# kubectl stdin"}}
  kubectl create -f - <<EOF
@@ -166,7 +166,7 @@
  You can download our example from the attachment area.
--Once you have your custom //values.yaml// file, deploy the app with Helm:
++Once you have your custom [[//values.yaml//>>attach:values.yaml]] file, deploy the app with Helm:
  {{code language="sh" layout="LINENUMBERS" title="# Helm install"}}
  helm install --namespace behemoth-wiki --create-namespace \
@@ -174,7 +174,40 @@
    behemoth-xwiki xwiki-helm/xwiki
  {{/code}}
--
++=== Upgrade ===
++
++To upgrade XWiki, you should read the content in [[XWiki official Helm pages regarding upgrades>>https://extensions.xwiki.org/xwiki/bin/view/Extension/XWikiHelm/#HUpgrading]].
++
++Theoretically, if there aren't any breaking changes or prerequisites, you can run:
++
++{{code language="sh" layout="LINENUMBERS" title="# Helm upgrade"}}
++helm upgrade --namespace behemoth-wiki \
++  --values values.yaml \
++  behemoth-xwiki xwiki-helm/xwiki
++
++{{/code}}
++
++=== Uninstall ===
++
++To fully remove XWiki, use the following commands:
++
++{{code language="sh" layout="LINENUMBERS" title="# Uninstalling"}}
++helm uninstall --namespace behemoth-wiki behemoth-xwiki
++kubectl -n behemoth-wiki delete pvc/data-behemoth-xwiki-mysql-0
++kubectl -n behemoth-wiki delete pvc/xwiki-data-behemoth-xwiki-0
++kubectl delete -f pv_storage.yaml
++kubectl delete namespace behemoth-wiki
++{{/code}}
++
++This will uninstall the chart, delete the PVCs, delete the PVs and lastly, delete the namespace.
++
++== Links ==
++
++1. [[XWiki - Extensions - Helm>>https://extensions.xwiki.org/xwiki/bin/view/Extension/XWikiHelm/]]
++1. [[Github - XWiki Contrib - Helm Charts>>https://github.com/xwiki-contrib/xwiki-helm]]
++1. [[Github - XWiki - Docker>>https://github.com/xwiki/xwiki-docker/]]
++1. [[Docker Hub - XWiki - Official>>https://hub.docker.com/_/xwiki]]
++1. [[Docker Hub - Behemoth LTD - Custom XWiki Non-root Image>>https://hub.docker.com/r/behemothil/xwiki-mysql-tomcat-nonroot]]
  )))
  (% class="col-xs-12 col-sm-4" %)

Dockerfile

Size

@@ -1,1 +1,1 @@
--6730
++6722

Content

@@ -91,7 +91,7 @@
  # Added by Behemoth LTD - Apr 28th, 2024
  # Fixing permissions error when using non-root user/group (30001:30001) to start the app
--RUN chown -R 30001:30001 /usr/local/tomcat/webapps
++RUN chown -R 30001:30001 /usr/local/tomcat
  USER 30001:30001
  # At this point the image is done and what remains below are the runtime configuration used by the user to configure

values.yaml

Size

@@ -1,1 +1,1 @@
--4.1 KB
++5.5 KB

Content

@@ -1,3 +1,6 @@
++# Default values for node.
++# This is a YAML-formatted file.
++# Declare variables to be passed into your templates.
  cluster:
    enabled: false
@@ -4,8 +4,11 @@
  image:
    name: xwiki
    pullPolicy: IfNotPresent
++## Image Tag useful when externalDB is been used
++## https://hub.docker.com/_/xwiki
    name: "behemothil/xwiki-mysql-tomcat-nonroot"
--  tag: "16.2.0-1"
++  tag: "16.2.0-2"
++#  tag: '16.2.0-mysql-tomcat'
  service:
    portName: node
    name: http
@@ -12,7 +12,11 @@
    type: ClusterIP
    externalPort: 80
    internalPort: 8080
++  # Set an array of externalIPs for the service
    externalIPs: []
++    # - 10.20.30.40
++    # - 10.20.30.41
++  # Reference: https://kubernetes.io/docs/reference/networking/virtual-ips/#session-affinity
    sessionAffinity: ClientIP
  resources:
    limits:
@@ -26,6 +26,7 @@
    - -Xms1024m
    - -Xmx6000m
++# Enable to choose witch kind of workload will be used: (true) StatefulSet or (false) for Deployment
  workloadStateful: true
  securityContext:
@@ -54,20 +54,36 @@
        type: "RuntimeDefault"
    enabled: true
++##
++## MySql chart configuration
++##
++## https://github.com/bitnami/charts/tree/main/bitnami/mysql
++##
  mysql:
++ ## Whether to deploy a mysql server. Set false for a different database.
    enabled: true
    image:
      tag: "8.0-debian-12"
      pullPolicy: "IfNotPresent"
    auth:
--    rootPassword: "ROOT_PASSWORD_CHANGEME !!!"
--    username: "USERNAME_CHANGEME !!!"
--    password: "USER_PASSWORD_CHANGEME !!!"
--    database: "DB_NAME_CHANGEME !!!"
++    rootPassword: "Wxv11dZmzw4YIozxj1"
++    username: "xwiki"
++    password: "3N5NBYnb5VQfDA2gde"
++    database: "xwiki"
    initdbScripts:
 -init.sql: |
        grant all privileges on *.* to xwiki@'%'
    primary:
++  #  initContainers:
++  #  - name: "fix-non-root-permissions"
++  #    image: "busybox"
++  #    imagePullPolicy: "IfNotPresent"
++  #    command: [ "chown", "-R", "30001:30001", "/opt/bitnami" ]
++  #    volumeMounts:
++  #    - name: conf
++  #      mountPath: /opt/bitnami
++    # Changed to use UTF8mb4, check future versions if this was already changed.
++    # TODO: review explicit_defaults_for_timestamp
      configuration: |-
        [mysqld]
        default_authentication_plugin=mysql_native_password
@@ -118,12 +118,25 @@
        seccompProfile:
          type: "RuntimeDefault"
++mariadb:
++  enabled: false
++
++postgresql:
++  enabled: false
++
++solr:
++  enabled: false
++
++# To use ingress for routing set ingress.enabled value to true and istio.enabled value to false
  ingress:
    enabled: true
    className: nginx
    annotations:
      kubernetes.io/ingress.class: nginx
++#    nginx.ingress.kubernetes.io/whitelist-source-range: "152.67.64.124/32, 178.255.149.139/32"
      cert-manager.io/cluster-issuer: letsencrypt-prod
++    # kubernetes.io/tls-acme: "true"
++    # ingress.kubernetes.io/rewrite-target: /
    hosts:
      - host: wiki.behemoth.co.il
        paths:
@@ -134,6 +134,9 @@
        hosts:
          - wiki.behemoth.co.il
++istio:
++  enabled: false
++
  persistence:
    enabled: true
    storageClass: "behemoth-xwiki-www"
@@ -141,6 +141,19 @@
      - ReadWriteOnce
    size: "5Gi"
++podDisruptionBudget:
++  enabled: false
++
++glowroot:
++  enabled: false
++
++logback:
++  enabled: false
++
++autoscaling:
++  enabled: false
++
++# Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
  probes:
    startup:
      enabled: true
@@ -160,6 +160,7 @@
      initialDelaySeconds: 30
      timeoutSeconds: 3
      periodSeconds: 30
++    # 5 minutes
      failureThreshold: 10
      successThreshold: 1
    readiness:
@@ -170,9 +170,13 @@
      initialDelaySeconds: 30
      timeoutSeconds: 3
      periodSeconds: 30
++    # 5 minutes
      failureThreshold: 10
      successThreshold: 1
++infinispan:
++  enabled: false
++
  prometheus:
    javaagent:
      # https://github.com/prometheus/jmx_exporter
@@ -179,23 +179,3 @@
      # Enable to download and use this agent
      enabled: true
--podDisruptionBudget:
--  enabled: false
--
--solr:
--  enabled: false
--istio:
--  enabled: false
--
--glowroot:
--  enabled: false
--
--logback:
--  enabled: false
--
--autoscaling:
--  enabled: false
--
--infinispan:
--  enabled: false
--

Changes for page XWiki (Helm)

Summary

Details

Navigation

Child Pages