Merge pull request #180 from itspluxstahre/fix_k8s_example

Fix k8s example
nanos · Oct 8, 2024 · 0dfac70 · 0dfac70
2 parents 5adea1c + c7d694d
commit 0dfac70
Showing 1 changed file with 57 additions and 44 deletions.
diff --git a/examples/k8s-cronjob.md b/examples/k8s-cronjob.md
@@ -12,6 +12,21 @@ kubectl create secret generic fedifetcher \
     --from-literal=token="<token>"
 ```
 
+Define a PVC, for example:
+
+```yaml
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: fedifetcher-pvc
+spec:
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 1Gi
+```
+
 Now define the cronjob, and don't forget to define your PVCs:
 
 ```yaml
@@ -20,52 +35,50 @@ kind: CronJob
 metadata:
   name: fedifetcher
 spec:
-  schedule: "*/15 * * * *"
-  failedJobsHistoryLimit: 5
-  successfulJobsHistoryLimit: 5
- concurrencyPolicy: Forbid
+  schedule: "*/15 * * * *"  # Run every 15 minutes
+  failedJobsHistoryLimit: 5  # Keep history of failed jobs
+  successfulJobsHistoryLimit: 5  # Keep history of successful jobs
+  concurrencyPolicy: Forbid  # Do not allow concurrent jobs
   jobTemplate:
     spec:
-        template:
-            spec:
-                restartPolicy: Never
-                containers:
-                - name: fedifetcher
-                  image: ghcr.io/nanos/fedifetcher:latest
-                  imagePullPolicy: IfNotPresent
-                  env:
-                    - name: FF_HOME_TIMELINE_LENGTH
-                      value: "200"
-                    - name: FF_MAX_FOLLOWERS
-                      value: "10"
-
-                    # Add any other options below as described in in the README.md file
-
-                    # If you don't want to use a PVC you may comment the next two lines, but that will significantly 
-                    # affect performance, and is NOT recommended
-                    - name: FF_STATE_DIR
-                      value: "/data/"
-                    - name: FF_SERVER
-                      valueFrom: 
-                        secretKeyRef:
-                            name: fedifetcher
-                            key: server_domain
-                            optional: false
-                    - name: FF_ACCESS_TOKEN
-                      valueFrom: 
-                         secretKeyRef:
-                            name: fedifetcher
-                            key: token
-                            optional: false
-                # Comment the lines below if you do not use a PVC, but that will significantly 
-                # affect performance and is NOT recommended
-                volumeMounts:
-                    - mountPath: /data
+      template:
+        spec:
+          restartPolicy: Never
+          containers:
+            - name: fedifetcher
+              image: ghcr.io/nanos/fedifetcher:latest
+              imagePullPolicy: IfNotPresent
+              env:
+                - name: FF_HOME_TIMELINE_LENGTH
+                  value: "200"
+                - name: FF_MAX_FOLLOWERS
+                  value: "10"
+                # Add any other options below as described in in the README.md file
+
+                # If you don't want to use a PVC you may comment the next two lines, but that will significantly 
+                # affect performance, and is NOT recommended
+                - name: FF_STATE_DIR
+                  value: "/data/"
+                - name: FF_SERVER
+                  valueFrom:
+                    secretKeyRef:
+                      name: fedifetcher
+                      key: server_domain
+                - name: FF_ACCESS_TOKEN
+                  valueFrom:
+                    secretKeyRef:
                       name: fedifetcher
-                      readOnly: false 
-                volumes:
-                    - name: fedifetcher               
-                      persistentVolumeClaim:
-                       claimName: fedifetcher
+                      key: token
+                      optional: false
+        # Comment the lines below if you do not use a PVC, but that will significantly 
+        # affect performance and is NOT recommended
+              volumeMounts:
+                - name: fedifetcher-storage
+                  mountPath: /data
+                  readOnly: false 
+          volumes:
+            - name: fedifetcher-storage
+              persistentVolumeClaim:
+                claimName: fedifetcher-pvc
 ```