tidy the docs

This commit is contained in:
JesseBot 2025-09-29 10:59:08 +02:00
parent dfb61283cf
commit d1444d1cc7
No known key found for this signature in database
3 changed files with 44 additions and 29 deletions

View file

@ -18,7 +18,7 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 1.6.1
version: 1.6.2
# renovate: image=docker.io/ghost
appVersion: "6.0.10"

View file

@ -1,6 +1,6 @@
# ghost
![Version: 1.6.1](https://img.shields.io/badge/Version-1.6.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 6.0.10](https://img.shields.io/badge/AppVersion-6.0.10-informational?style=flat-square)
![Version: 1.6.2](https://img.shields.io/badge/Version-1.6.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 6.0.10](https://img.shields.io/badge/AppVersion-6.0.10-informational?style=flat-square)
A Helm chart for deploying Ghost on Kubernetes
@ -30,12 +30,12 @@ A Helm chart for deploying Ghost on Kubernetes
| activity_pub.externalDatabase.secretKeys.root_password | string | `""` | secret key in existing k8s secret for ActivityPub database root password |
| activity_pub.externalDatabase.secretKeys.username | string | `""` | secret key in existing k8s secret for ActivityPub database username |
| activity_pub.externalDatabase.username | string | `""` | database username. ignored if existingSecret not "" |
| activity_pub.podSecurityContext | object | `{}` | Configure Pods Security Context ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod |
| activity_pub.resources | object | `{}` | pod resources: requested cpu/mem and limits for cpu/mem |
| activity_pub.securityContext | object | `{}` | |
| activity_pub.service.port | int | `8080` | This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports |
| activity_pub.service.targetPort | int | `8080` | this is the port in the container you want to contact |
| activity_pub.service.type | string | `"ClusterIP"` | This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types |
| activity_pub.podSecurityContext | object | `{}` | ActivityPub Configure Pods Security Context ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod |
| activity_pub.resources | object | `{}` | ActivityPub pod resources: requested cpu/mem and limits for cpu/mem |
| activity_pub.securityContext | object | `{}` | ActivityPub Configure container Security Context |
| activity_pub.service.port | int | `8080` | sets the ActivityPub ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports |
| activity_pub.service.targetPort | int | `8080` | port in the ActivityPub container you want to contact |
| activity_pub.service.type | string | `"ClusterIP"` | sets the ActivityPub service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types |
| activity_pub.useMq | bool | `false` | use MQ |
| activity_pub.version | string | `"1.1"` | ActivityPub verison |
| affinity | object | `{}` | pod or node affinity |
@ -102,8 +102,8 @@ A Helm chart for deploying Ghost on Kubernetes
| persistence.accessModes | list | `[]` | accessModes for the PVC (ignored if persistence.existingClaim is set) |
| persistence.existingClaim | string | `""` | use an existing Kubernetes Peristent Volume Claim |
| persistence.storage | string | `"1Gi"` | size of the PVC (ignored if persistence.existingClaim is set) |
| podAnnotations | object | `{}` | This is for setting Kubernetes Annotations to a Pod. For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ |
| podLabels | object | `{}` | This is for setting Kubernetes Labels to a Pod. For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| podAnnotations | object | `{}` | This is for setting Kubernetes Annotations to a Pod. For more info checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ |
| podLabels | object | `{}` | This is for setting Kubernetes Labels to a Pod. For more info checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ |
| podSecurityContext | object | `{}` | Configure Pods Security Context ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod |
| readinessProbe.httpGet.path | string | `"/"` | |
| readinessProbe.httpGet.port | string | `"http"` | |

View file

@ -2,10 +2,12 @@
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.
# -- This will set the replicaset count more information can be found here: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/
# -- This will set the replicaset count more information can be found here:
# https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/
replicaCount: 1
# This sets the container image more information can be found here: https://kubernetes.io/docs/concepts/containers/images/
# This sets the container image more information can be found here:
# https://kubernetes.io/docs/concepts/containers/images/
image:
# -- image repo
repository: ghost
@ -14,7 +16,8 @@ image:
# Overrides the image tag whose default is the chart appVersion.
tag: ""
# This is for the secrets for pulling an image from a private repository more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
# secrets for pulling an image from a private repository more info can be found here:
# https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
imagePullSecrets: []
# -- This is to override the chart name.
@ -23,7 +26,8 @@ nameOverride: ""
# -- fullname Override
fullnameOverride: ""
# This section builds out the service account more information can be found here: https://kubernetes.io/docs/concepts/security/service-accounts/
# This section builds out the service account more information can be found here:
# https://kubernetes.io/docs/concepts/security/service-accounts/
serviceAccount:
# -- Specifies whether a service account should be created
create: true
@ -35,11 +39,12 @@ serviceAccount:
# If not set and create is true, a name is generated using the fullname template
name: ""
# -- This is for setting Kubernetes Annotations to a Pod.
# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
# -- This is for setting Kubernetes Annotations to a Pod. For more info checkout:
# https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
podAnnotations: {}
# -- This is for setting Kubernetes Labels to a Pod.
# For more information checkout: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
# -- This is for setting Kubernetes Labels to a Pod. For more info checkout:
# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
podLabels: {}
# -- Configure Pods Security Context
@ -55,16 +60,20 @@ securityContext: {}
# runAsNonRoot: true
# runAsUser: 1000
# This is for setting up a service more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/
# This is for setting up a service more information can be found here:
# https://kubernetes.io/docs/concepts/services-networking/service/
service:
# -- This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
# -- This sets the service type more information can be found here:
# https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
type: ClusterIP
# -- This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports
# -- This sets the ports more information can be found here:
# https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports
port: 80
# -- this is the port in the container you want to contact
targetPort: 2368
# This block is for setting up the ingress for more information can be found here: https://kubernetes.io/docs/concepts/services-networking/ingress/
# This block is for setting up the ingress for more information can be found here:
# https://kubernetes.io/docs/concepts/services-networking/ingress/
ingress:
# -- enable ingress from outside the cluster
enabled: false
@ -92,17 +101,20 @@ resources: {}
# cpu: 100m
# memory: 128Mi
# This is to setup the liveness and readiness probes more information can be found here: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
# This is to setup the liveness and readiness probes more information can be found here:
# https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
livenessProbe:
httpGet:
path: /
port: http
readinessProbe:
httpGet:
path: /
port: http
# This section is for setting up autoscaling more information can be found here: https://kubernetes.io/docs/concepts/workloads/autoscaling/
# This section is for setting up autoscaling more information can be found here:
# https://kubernetes.io/docs/concepts/workloads/autoscaling/
autoscaling:
# -- enable autoscaling
enabled: false
@ -291,14 +303,16 @@ activity_pub:
connection_string: ""
service:
# -- This sets the service type more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
# -- sets the ActivityPub service type more information can be found here:
# https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
type: ClusterIP
# -- This sets the ports more information can be found here: https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports
# -- sets the ActivityPub ports more information can be found here:
# https://kubernetes.io/docs/concepts/services-networking/service/#field-spec-ports
port: 8080
# -- this is the port in the container you want to contact
# -- port in the ActivityPub container you want to contact
targetPort: 8080
# -- pod resources: requested cpu/mem and limits for cpu/mem
# -- ActivityPub pod resources: requested cpu/mem and limits for cpu/mem
resources: {}
# limits:
# cpu: 100m
@ -307,11 +321,12 @@ activity_pub:
# cpu: 100m
# memory: 128Mi
# -- Configure Pods Security Context
# -- ActivityPub Configure Pods Security Context
# ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod
podSecurityContext: {}
# fsGroup: 2000
# -- ActivityPub Configure container Security Context
securityContext: {}
# capabilities:
# drop: