Changes for page XWiki (Helm)

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

From 12.1 to 11.1 From 18.1 to 17.1

From version 17.1

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

Change comment: There is no comment for this version

To version 12.1

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

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

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -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.
--=== Build and Publish ===
++=== Building and Publish ===
  You will need to perform the following actions:
@@ -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:
  {{code language="sh" layout="LINENUMBERS" title="# kubectl stdin"}}
  kubectl create -f - <<EOF
@@ -144,70 +144,10 @@
  This will create 2 PVs that we'll use later. Notice //nodeAffinity//, linking the deployment to a specific node (the pods can run only at that location, as the PV is defined only there).
--Now we can install XWiki's charts (repo) and download it's //values.yaml// file:
++Download the Charts and Values file:
--{{code language="sh" layout="LINENUMBERS" title="# Charts and Values"}}
--helm repo add xwiki-helm https://xwiki-contrib.github.io/xwiki-helm
--helm repo update xwiki-helm
--curl -LO https://raw.githubusercontent.com/xwiki-contrib/xwiki-helm/master/charts/xwiki/values.yaml
--{{/code}}
--
--Modify the values.yaml file, our example has:
--
--* Using custom image (so it won't run as //root//).
--* Increased memory/core usage allowance.
--* Running as UID/GID 30001.
--* Dropping all capabilities.
--* Using MySQL.
--* Enabling persistence.
--* Ingress (Nginx).
--* TLS (Cert manager)
--
--You can download our example from the attachment area.
--
--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 \
--  --values values.yaml \
--  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" %)

values.yaml

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.itzhak

Size

...	...	@@ -1,1 +1,0 @@
1		-4.1 KB

Content

@@ -1,201 +1,0 @@
--cluster:
--  enabled: false
--
--image:
--  name: xwiki
--  pullPolicy: IfNotPresent
--  name: "behemothil/xwiki-mysql-tomcat-nonroot"
--  tag: "16.2.0-1"
--service:
--  portName: node
--  name: http
--  type: ClusterIP
--  externalPort: 80
--  internalPort: 8080
--  externalIPs: []
--  sessionAffinity: ClientIP
--resources:
--  limits:
--    cpu: 4500m
--    memory: 6144Mi
--  requests:
--    cpu: 1000m
--    memory: 1024Mi
--
--javaOpts:
--  - -Xms1024m
--  - -Xmx6000m
--
--workloadStateful: true
--
--securityContext:
--  enabled: true
--  runAsUser: 30001
--  runAsGroup: 30001
--  fsGroup: 30001
--
--containerSecurityContext:
--  enabled: true
--  runAsUser: 30001
--  runAsGroup: 30001
--  runAsNonRoot: true
--  allowPrivilegeEscalation: false
--  capabilities:
--    drop: ["ALL"]
--  seccompProfile:
--    type: "RuntimeDefault"
--
--volumePermissions:
--  containerSecurityContext:
--    enabled: false
--    runAsUser: 30001
--    runAsGroup: 30001
--    seccompProfile:
--      type: "RuntimeDefault"
--  enabled: true
--
--mysql:
--  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 !!!"
--  initdbScripts:
--    00-init.sql: |
--      grant all privileges on *.* to xwiki@'%'
--  primary:
--    configuration: |-
--      [mysqld]
--      default_authentication_plugin=mysql_native_password
--      skip-name-resolve
--      explicit_defaults_for_timestamp
--      basedir=/opt/bitnami/mysql
--      plugin_dir=/opt/bitnami/mysql/lib/plugin
--      port=3306
--      socket=/opt/bitnami/mysql/tmp/mysql.sock
--      datadir=/bitnami/mysql/data
--      tmpdir=/opt/bitnami/mysql/tmp
--      max_allowed_packet=16M
--      bind-address=*
--      pid-file=/opt/bitnami/mysql/tmp/mysqld.pid
--      log-error=/opt/bitnami/mysql/logs/mysqld.log
--      character-set-server=UTF8MB4
--      collation-server=utf8mb4_0900_ai_ci
--      slow_query_log=0
--      slow_query_log_file=/opt/bitnami/mysql/logs/mysqld.log
--      long_query_time=10.0
--
--      [client]
--      port=3306
--      socket=/opt/bitnami/mysql/tmp/mysql.sock
--      default-character-set=UTF8MB4
--      plugin_dir=/opt/bitnami/mysql/lib/plugin
--
--      [manager]
--      port=3306
--      socket=/opt/bitnami/mysql/tmp/mysql.sock
--      pid-file=/opt/bitnami/mysql/tmp/mysqld.pid
--    persistence:
--      enabled: true
--      storageClass: "behemoth-xwiki-db"
--      accessModes:
--      - ReadWriteOnce
--      size: "5Gi"
--    containerSecurityContext:
--      enabled: true
--      seLinuxOptions: {}
--      runAsUser: 30001
--      runAsGroup: 0
--      fsGroup: 30001
--      runAsNonRoot: false
--      allowPrivilegeEscalation: false
--      capabilities:
--        drop: ["ALL"]
--      seccompProfile:
--        type: "RuntimeDefault"
--
--ingress:
--  enabled: true
--  className: nginx
--  annotations:
--    kubernetes.io/ingress.class: nginx
--    cert-manager.io/cluster-issuer: letsencrypt-prod
--  hosts:
--    - host: wiki.behemoth.co.il
--      paths:
--        - path: /
--          pathType: ImplementationSpecific
--  tls:
--    - secretName: wiki-behemoth-tls
--      hosts:
--        - wiki.behemoth.co.il
--
--persistence:
--  enabled: true
--  storageClass: "behemoth-xwiki-www"
--  accessModes:
--    - ReadWriteOnce
--  size: "5Gi"
--
--probes:
--  startup:
--    enabled: true
--    httpGet:
--      enabled: false
--      path: /
--    initialDelaySeconds: 120
--    timeoutSeconds: 60
--    periodSeconds: 30
--    failureThreshold: 5
--    successThreshold: 1
--  liveness:
--    enabled: true
--    httpGet:
--      enabled: true
--      path: /rest
--    initialDelaySeconds: 30
--    timeoutSeconds: 3
--    periodSeconds: 30
--    failureThreshold: 10
--    successThreshold: 1
--  readiness:
--    enabled: true
--    httpGet:
--      enabled: true
--      path: /rest/wikis/xwiki/spaces
--    initialDelaySeconds: 30
--    timeoutSeconds: 3
--    periodSeconds: 30
--    failureThreshold: 10
--    successThreshold: 1
--
--prometheus:
--  javaagent:
--    # https://github.com/prometheus/jmx_exporter
--    # 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