Merge pull request #179 from stoneshi-yunify/master

add s2i config

Author: stoneshi-yunify

OWNERS

@@ -1,9 +1,7 @@
 approvers:
-    - shaowenchen
-    - linuxsuren
+    - stoneshi-yunify
+    - renyunkang
 
 reviewers:
-    - magicsong
-    - runzexia
-    - shaowenchen
-    - JohnNiang
+    - stoneshi-yunify
+    - renyunkang

README.md

@@ -16,28 +16,9 @@ Compare with native S2I, S2I Operator also has the following advantages on the o
 
 ## Installation
 
-#### Prerequisites
-
-1. A Kubernetes cluster. (if you don't have an existing cluster, please [create it](https://kubernetes.io/docs/setup/).
-2. Grant cluster-admin permissions to the current user.
-
-#### Install S2I Operator
-
-You can install S2I Operator in any kubernetes cluster with following commands:
-
-```shell
-# create a namespaces, such as kubesphere-devops-system
-kubectl create ns kubesphere-devops-system
-# create S2I Operator and all CRD 
-kubectl apply -f  https://github.com/kubesphere/s2ioperator/releases/download/v0.0.2/s2ioperator.yaml
-```
-
-Now monitor the S2I Operator components show a `STATUS` of `Running`:
-
-```shell
-# please change you namespace
-kubectl -n kubesphere-devops-system get pods -w
-```
+For better experience, please install S2I Operator via following steps:
+1. Refer to https://kubesphere.io and install latest KubeSphere on your cluster.
+2. Login KubeSphere console, open the 'KubeSphere Marketplace', and install the `Image Builder` extension.
 
 ## Quick Start
 

cmd/manager/main.go

@@ -22,6 +22,7 @@ import (
 
 	"github.com/kubesphere/s2ioperator/pkg/apis"
 	"github.com/kubesphere/s2ioperator/pkg/apis/devops/v1alpha1"
+	s2iconfig "github.com/kubesphere/s2ioperator/pkg/config"
 	"github.com/kubesphere/s2ioperator/pkg/controller"
 	"github.com/kubesphere/s2ioperator/pkg/handler"
 	"github.com/kubesphere/s2ioperator/pkg/metrics"
@@ -41,10 +42,21 @@ func init() {
 
 func main() {
 	var metricsAddr string
+	var s2iRunJobTemplatePath string // checkout config/templates/s2irun-template.yaml for example
 	flag.StringVar(&metricsAddr, "metrics-addr", ":8080", "The address the metric endpoint binds to.")
+	flag.StringVar(&s2iRunJobTemplatePath, "s2irun-job-template", "/etc/template/job.yaml", "the s2irun job template file path")
 	flag.Parse()
 	log := ctrl.Log.WithName("entrypoint")
 
+	jobTemplateData, err := os.ReadFile(s2iRunJobTemplatePath)
+	if err != nil {
+		log.Error(err, "failed to read s2irun template file", "filename", s2iRunJobTemplatePath)
+		os.Exit(1)
+	}
+	s2iConfig := &s2iconfig.Config{
+		S2IRunJobTemplate: jobTemplateData,
+	}
+
 	// Get a config to talk to the apiserver
 	log.Info("setting up client for manager")
 	cfg, err := config.GetConfig()
@@ -78,7 +90,7 @@ func main() {
 
 	// Setup all Controllers
 	log.Info("Setting up controller")
-	if err := controller.AddToManager(mgr); err != nil {
+	if err := controller.AddToManager(mgr, s2iConfig); err != nil {
 		log.Error(err, "unable to register controllers to the manager")
 		os.Exit(1)
 	}

config/templates/s2irun-template.yaml

@@ -0,0 +1,72 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: s2irun-template
+data:
+  job.yaml: |
+    apiVersion: batch/v1
+    kind: Job
+    metadata:
+      name: {{.ObjectMetaName}}
+      namespace: {{.ObjectMetaNamespace}}
+    spec:
+      backoffLimit: {{.SpecBackoffLimit}}
+      template:
+        metadata:
+          labels:
+            job-name: {{.SpecTemplateObjectMetaLabelJobName}}
+        spec:
+          affinity:
+            nodeAffinity:
+              preferredDuringSchedulingIgnoredDuringExecution:
+                - preference:
+                    matchExpressions:
+                      - key: node-role.kubernetes.io/worker
+                        operator: In
+                        values:
+                          - ci
+                  weight: 1
+          containers:
+            - env:
+                - name: S2I_CONFIG_PATH
+                  value: /etc/data/config.json
+                - name: POD_NAMESPACE
+                  valueFrom:
+                    fieldRef:
+                      apiVersion: v1
+                      fieldPath: metadata.namespace
+                - name: POD_NAME
+                  valueFrom:
+                    fieldRef:
+                      apiVersion: v1
+                      fieldPath: metadata.name
+              image: {{.ContainerS2IRunImage}}
+              imagePullPolicy: IfNotPresent
+              name: s2irun
+              volumeMounts:
+                - mountPath: /etc/data
+                  name: config-data
+                  readOnly: true
+                - mountPath: /var/run/docker.sock
+                  name: docker-sock
+          serviceAccountName: {{.SpecTemplateSpecServiceAccountName}}
+          restartPolicy: Never
+          tolerations:
+            - effect: NoSchedule
+              key: node.kubernetes.io/ci
+              operator: Exists
+            - effect: PreferNoSchedule
+              key: node.kubernetes.io/ci
+              operator: Exists
+          volumes:
+            - configMap:
+                defaultMode: 420
+                items:
+                  - key: data
+                    path: config.json
+                name: {{.ConfigMapName}}
+              name: config-data
+            - hostPath:
+                path: /var/run/docker.sock
+                type: ""
+              name: docker-sock

pkg/config/types.go

@@ -0,0 +1,5 @@
+package config
+
+type Config struct {
+	S2IRunJobTemplate []byte // the template file content
+}

pkg/controller/controller.go

@@ -17,16 +17,17 @@ limitations under the License.
 package controller
 
 import (
+	"github.com/kubesphere/s2ioperator/pkg/config"
 	"sigs.k8s.io/controller-runtime/pkg/manager"
 )
 
 // AddToManagerFuncs is a list of functions to add all Controllers to the Manager
-var AddToManagerFuncs []func(manager.Manager) error
+var AddToManagerFuncs []func(mgr manager.Manager, cfg *config.Config) error
 
 // AddToManager adds all Controllers to the Manager
-func AddToManager(m manager.Manager) error {
+func AddToManager(m manager.Manager, cfg *config.Config) error {
 	for _, f := range AddToManagerFuncs {
-		if err := f(m); err != nil {
+		if err := f(m, cfg); err != nil {
 			return err
 		}
 	}

pkg/controller/s2ibuilder/s2ibuilder_controller.go

@@ -20,6 +20,7 @@ import (
 	"context"
 	"reflect"
 
+	"github.com/kubesphere/s2ioperator/pkg/config"
 	"github.com/kubesphere/s2ioperator/pkg/util/sliceutil"
 	v1 "k8s.io/api/apps/v1"
 
@@ -50,7 +51,7 @@ const s2iBuilderFinalizerName = "s2ibuilders.finalizers.kubesphere.io"
 
 // Add creates a new S2iBuilder Controller and adds it to the Manager with default RBAC. The Manager will set fields on the Controller
 // and Start it when the Manager is Started.
-func Add(mgr manager.Manager) error {
+func Add(mgr manager.Manager, cfg *config.Config) error {
 	return add(mgr, newReconciler(mgr))
 }
 

pkg/controller/s2irun/ksbuilder_jobs.go

@@ -138,7 +138,6 @@ type JobTemplateData struct {
 	SpecTemplateSpecServiceAccountName string
 	ContainerS2IRunImage               string
 	SpecBackoffLimit                   int32
-	SpecTTLSecondsAfterFinished        int32
 	ConfigMapName                      string
 }
 
@@ -158,21 +157,16 @@ func (r *ReconcileS2iRun) getJobTemplateData(instance *devopsv1alpha1.S2iRun) (*
 		SpecTemplateSpecServiceAccountName: RegularServiceAccount,
 		ContainerS2IRunImage:               imageName,
 		SpecBackoffLimit:                   instance.Spec.BackoffLimit,
-		SpecTTLSecondsAfterFinished:        instance.Spec.SecondsAfterFinished,
 		ConfigMapName:                      configMapName,
 	}
 	return data, nil
 }
 
-func (r *ReconcileS2iRun) GenerateNewJob(instance *devopsv1alpha1.S2iRun, templatePath string) (*batchv1.Job, error) {
+func (r *ReconcileS2iRun) GenerateNewJob(instance *devopsv1alpha1.S2iRun, templateContent []byte) (*batchv1.Job, error) {
 	templateData, err := r.getJobTemplateData(instance)
 	if err != nil {
 		return nil, err
 	}
-	templateContent, err := os.ReadFile(templatePath)
-	if err != nil {
-		return nil, err
-	}
 	tmpl, err := template.New("job").Parse(string(templateContent))
 	if err != nil {
 		return nil, err
@@ -185,6 +179,12 @@ func (r *ReconcileS2iRun) GenerateNewJob(instance *devopsv1alpha1.S2iRun, templa
 	var job batchv1.Job
 	decoder := yaml.NewYAMLOrJSONDecoder(&buf, 4096)
 	err = decoder.Decode(&job)
+	if err != nil {
+		return nil, err
+	}
+	if instance.Spec.SecondsAfterFinished > 0 {
+		job.Spec.TTLSecondsAfterFinished = &instance.Spec.SecondsAfterFinished
+	}
 	return &job, err
 }
 

pkg/controller/s2irun/s2irun_controller.go

@@ -23,6 +23,7 @@ import (
 	"reflect"
 	"time"
 
+	"github.com/kubesphere/s2ioperator/pkg/config"
 	v12 "k8s.io/api/rbac/v1"
 
 	devopsv1alpha1 "github.com/kubesphere/s2ioperator/pkg/apis/devops/v1alpha1"
@@ -55,7 +56,6 @@ const (
 	RegularRoleName          = "s2i-regular-role"
 	RegularRoleBinding       = "s2i-regular-rolebinding"
 	DefaultRevisionId        = "master"
-	JobTemplateYaml          = "/etc/data/job-template.yaml"
 )
 
 /**
@@ -65,13 +65,17 @@ const (
 
 // Add creates a new S2iRun Controller and adds it to the Manager with default RBAC. The Manager will set fields on the Controller
 // and Start it when the Manager is Started.
-func Add(mgr manager.Manager) error {
-	return add(mgr, newReconciler(mgr))
+func Add(mgr manager.Manager, cfg *config.Config) error {
+	return add(mgr, newReconciler(mgr, cfg))
 }
 
 // newReconciler returns a new reconcile.Reconciler
-func newReconciler(mgr manager.Manager) reconcile.Reconciler {
-	return &ReconcileS2iRun{Client: mgr.GetClient(), scheme: mgr.GetScheme()}
+func newReconciler(mgr manager.Manager, cfg *config.Config) reconcile.Reconciler {
+	return &ReconcileS2iRun{
+		Client: mgr.GetClient(),
+		scheme: mgr.GetScheme(),
+		cfg:    cfg,
+	}
 }
 
 // add adds a new Controller to mgr with r as the reconcile.Reconciler
@@ -112,6 +116,7 @@ var _ reconcile.Reconciler = &ReconcileS2iRun{}
 type ReconcileS2iRun struct {
 	client.Client
 	scheme *runtime.Scheme
+	cfg    *config.Config
 }
 
 // Reconcile reads that state of the cluster for a S2iRun object and makes changes based on the state read
@@ -258,7 +263,7 @@ func (r *ReconcileS2iRun) Reconcile(ctx context.Context, request reconcile.Reque
 	}
 
 	//job set up
-	job, err := r.GenerateNewJob(instance, JobTemplateYaml)
+	job, err := r.GenerateNewJob(instance, r.cfg.S2IRunJobTemplate)
 	if err != nil {
 		log.Error(err, "Failed to initialize a job")
 		return reconcile.Result{}, err