Merge pull request #2 from gianlucam76/documentation

Modify README

Author: gianlucam76

Makefile

@@ -147,11 +147,11 @@ create-cluster: $(KIND) $(KUBECTL) ## Create a new kind cluster designed for dev
 @echo "apply PersistentVolumeClaim"
 $(KUBECTL) apply -f test/pvc.yaml
 
-$(KUBECTL) apply -f test/fv/configmap.yaml
+$(KUBECTL) apply -f test/configmap.yaml
 
 @echo 'Load k8s-collector image into cluster'
 $(MAKE) load-image
-$(KUBECTL) apply -f k8s/collector.yaml
+$(KUBECTL) apply -f test/collector.yaml
 
 .PHONY: delete-cluster
 delete-cluster: $(KIND) ## Deletes the kind cluster $(CONTROL_CLUSTER_NAME)

README.md

@@ -2,11 +2,14 @@
 A Kubernetes Job to collect resources, logs and events from a Kubernetes cluster.
 k8s-collector is a Job that can collect both resources (YAMLs) and logs when created.
 
-`k8s/collector.yaml` contains the YAML to run it. Please be aware you will have to modify Job volume mounts.
-It expects two argurments:
+[k8s/collector.yaml](https://raw.githubusercontent.com/gianlucam76/k8s_collector/main/k8s/collector.yaml) contains the YAML to run it. Please be aware you will have to modify Job volume mounts (as it will store logs and resources in tmp directory).
+If you want to try it out on [Kind](https://kind.sigs.k8s.io) cluster, then you can use this YAML which uses a persistent volume provided by KinD 
+[test/fv/collector.yaml](https://raw.githubusercontent.com/gianlucam76/k8s_collector/main/test/fv/collector.yaml)
 
-1. config-map => this is the name of the ConfigMap that contain the configuration on which logs/resources to collect. This README contains an example for such ConfigMap. ConfigMap must be in the same namespae of the Job.
-2. dir => this is the directory when all collected resources and logs will be stored 
+```k8s-collector``` expects two argurments:
+
+1. dir => this is the directory when all collected resources and logs will be stored 
+2. config-map => this is the name of the ConfigMap that contain the configuration on which logs/resources to collect. This README contains an example for such ConfigMap. ConfigMap must be in the same namespae of the Job.
 
 ```yaml
 apiVersion: batch/v1

k8s/collector.yaml

@@ -32,18 +32,13 @@ spec:
  - /k8s-collector
  args:
  - --config-map=k8s-collector
- - --dir=/collection
+ - --dir=/tmp
  volumeMounts:
- - mountPath: /collection
- name: collection
  - mountPath: /tmp
  name: tmp
  volumes:
  - emptyDir: {}
  name: tmp
- - name: collection
- persistentVolumeClaim:
- claimName: standard
 ---
 kind: ClusterRole
 apiVersion: rbac.authorization.k8s.io/v1

test/collector.yaml

@@ -0,0 +1,80 @@
+apiVersion: v1
+kind: Namespace
+metadata:
+ name: default
+---
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+ name: k8s-collector
+ namespace: default
+---
+apiVersion: batch/v1
+kind: Job
+metadata:
+ name: k8s-collector
+ namespace: default
+spec:
+ template:
+ spec:
+ restartPolicy: Never
+ serviceAccountName: k8s-collector
+ containers:
+ - name: k8s-collector
+ image: projectsveltos/k8s-collector-amd64:main
+ imagePullPolicy: IfNotPresent
+ env:
+ - name: COLLECTOR_NAMESPACE
+ valueFrom:
+ fieldRef:
+ fieldPath: metadata.namespace
+ command:
+ - /k8s-collector
+ args:
+ - --config-map=k8s-collector
+ - --dir=/collection
+ volumeMounts:
+ - mountPath: /collection
+ name: collection
+ - mountPath: /tmp
+ name: tmp
+ volumes:
+ - emptyDir: {}
+ name: tmp
+ - name: collection
+ persistentVolumeClaim:
+ claimName: standard
+---
+kind: ClusterRole
+apiVersion: rbac.authorization.k8s.io/v1
+metadata:
+ name: k8s-collector
+rules:
+ - apiGroups:
+ - "*"
+ resources:
+ - "*"
+ verbs:
+ - get
+ - list
+ - apiGroups:
+ - "batch/v1"
+ verbs:
+ - "get"
+ - "list"
+ - "watch"
+ resources:
+ - "pods/logs"
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+ name: k8s-collector
+roleRef:
+ apiGroup: rbac.authorization.k8s.io
+ kind: ClusterRole
+ name: k8s-collector
+subjects:
+- kind: ServiceAccount
+ name: k8s-collector
+ namespace: default