add readme and remove not used env

kyma-project · Mar 29, 2024 · f0917bd · f0917bd
1 parent d538529
commit f0917bd
Show file tree

Hide file tree

Showing 8 changed files with 27 additions and 17 deletions.
diff --git a/components/operator/README.md b/components/operator/README.md
@@ -0,0 +1,19 @@
+# Function Operator
+
+The Function Operator is a Kubernetes controller that install Serverless.
+
+## Prerequisites
+The Function Operator requires the following components to be installed:
+- [Go](https://go.dev/)
+
+## Development
+
+### Run/Debug local sources locally
+
+### Environment Variables
+
+#### The Function Operator Uses These Environment Variables:
+
+| Variable                         | Description                  | Default value                                                                                                                                          |
+|----------------------------------|------------------------------| ------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **CHART_PATH**                   | Location of serverless chart | `/module-chart`                                                                                                                                                       |
diff --git a/components/operator/controllers/serverless_controller.go b/components/operator/controllers/serverless_controller.go
@@ -41,12 +41,12 @@ type serverlessReconciler struct {
 	log              *zap.SugaredLogger
 }
 
-func NewServerlessReconciler(client client.Client, config *rest.Config, recorder record.EventRecorder, log *zap.SugaredLogger, chartPath string, ns string) *serverlessReconciler {
+func NewServerlessReconciler(client client.Client, config *rest.Config, recorder record.EventRecorder, log *zap.SugaredLogger, chartPath string) *serverlessReconciler {
 	cache := chart.NewSecretManifestCache(client)
 
 	return &serverlessReconciler{
 		initStateMachine: func(log *zap.SugaredLogger) state.StateReconciler {
-			return state.NewMachine(client, config, recorder, log, cache, chartPath, ns)
+			return state.NewMachine(client, config, recorder, log, cache, chartPath)
 		},
 		client: client,
 		log:    log,

diff --git a/components/operator/controllers/suite_test.go b/components/operator/controllers/suite_test.go
@@ -97,9 +97,8 @@ var _ = BeforeSuite(func() {
 		k8sManager.GetConfig(),
 		record.NewFakeRecorder(100),
 		reconcilerLogger.Sugar(),
-		chartPath,
-		"",
-	)).SetupWithManager(k8sManager)
+		chartPath)).
+		SetupWithManager(k8sManager)
 	Expect(err).ToNot(HaveOccurred())
 
 	go func() {

diff --git a/components/operator/internal/config/config.go b/components/operator/internal/config/config.go
@@ -3,8 +3,7 @@ package config
 import "github.com/vrischmann/envconfig"
 
 type Config struct {
-	ChartPath                  string `envconfig:"default=/module-chart"`
-	ServerlessManagerNamespace string `envconfig:"default=default"`
+	ChartPath string `envconfig:"default=/module-chart"`
 }
 
 func GetConfig(prefix string) (Config, error) {

diff --git a/components/operator/internal/state/fsm.go b/components/operator/internal/state/fsm.go
@@ -31,7 +31,6 @@ type stateFn func(context.Context, *reconciler, *systemState) (stateFn, *ctrl.Re
 type cfg struct {
 	finalizer     string
 	chartPath     string
-	namespace     string
 	managerPodUID string
 }
 

diff --git a/components/operator/internal/state/new.go b/components/operator/internal/state/new.go
@@ -17,15 +17,14 @@ type StateReconciler interface {
 	Reconcile(ctx context.Context, v v1alpha1.Serverless) (ctrl.Result, error)
 }
 
-func NewMachine(client client.Client, config *rest.Config, recorder record.EventRecorder, log *zap.SugaredLogger, cache chart.ManifestCache, chartPath, namespace string) StateReconciler {
+func NewMachine(client client.Client, config *rest.Config, recorder record.EventRecorder, log *zap.SugaredLogger, cache chart.ManifestCache, chartPath string) StateReconciler {
 	return &reconciler{
 		fn:    sFnServedFilter,
 		cache: cache,
 		log:   log,
 		cfg: cfg{
 			finalizer:     v1alpha1.Finalizer,
 			chartPath:     chartPath,
-			namespace:     namespace,
 			managerPodUID: os.Getenv("SERVERLESS_MANAGER_UID"),
 		},
 		k8s: k8s{

diff --git a/components/operator/main.go b/components/operator/main.go
@@ -88,7 +88,7 @@ func main() {
 	ctx, cancel := context.WithTimeout(context.Background(), cleanupTimeout)
 	defer cancel()
 
-	setupLog.Info("cleaning orphan depricated resources")
+	setupLog.Info("cleaning orphan deprecated resources")
 	err = cleanupOrphanDeprecatedResources(ctx)
 	if err != nil {
 		setupLog.Error(err, "while removing orphan resources")
@@ -131,8 +131,7 @@ func main() {
 		mgr.GetClient(), mgr.GetConfig(),
 		mgr.GetEventRecorderFor("serverless-operator"),
 		reconcilerLogger.Sugar(),
-		cfg.ChartPath,
-		cfg.ServerlessManagerNamespace)
+		cfg.ChartPath)
 
 	if err = reconciler.SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "Serverless")

diff --git a/config/operator/base/deployment/deployment.yaml b/config/operator/base/deployment/deployment.yaml
@@ -32,10 +32,6 @@ spec:
         image: controller:latest
         name: manager
         env:
-        - name: SERVERLESS_MANAGER_NAMESPACE
-          valueFrom:
-            fieldRef:
-              fieldPath: metadata.namespace
         - name: SERVERLESS_MANAGER_UID
           valueFrom:
             fieldRef: