From f5d8e17644c0645653a7605955885ef5609e9548 Mon Sep 17 00:00:00 2001 From: Damian Badura Date: Fri, 5 Apr 2024 10:58:48 +0200 Subject: [PATCH] add description of one env --- components/operator/README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/components/operator/README.md b/components/operator/README.md index a96617634..345498c46 100644 --- a/components/operator/README.md +++ b/components/operator/README.md @@ -3,7 +3,9 @@ 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 @@ -11,23 +13,27 @@ The Function Operator requires the following components to be installed: ### Installing locally build serverless operator image on k3d with serverless To install serverless-manager from local sources on k3d cluster run: + ```bash make install-operator-k3d ``` This target does: + - build local image with serverless-operator - tag local serverless-operator image with its hash to be sure to deployment be updated - upload local image to k3d - update image in serverless-operator deployment ### Running/Debugging serverless-operator locally + To develop the component as normal binary, set up environment variables. ### Environment Variables #### The Function Operator Uses These Environment Variables: -| Variable | Description | Default value | -|----------------------------------|------------------------------| ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| **CHART_PATH** | Location of serverless chart | `/module-chart` | +| Variable | Description | Default value | +|----------------------------|---------------------------------------------------------------------------------------------------------------------|-----------------| +| **CHART_PATH** | Location of serverless chart | `/module-chart` | +| **SERVERLESS_MANAGER_UID** | Unique ID of operator instance. Used to mark created resources to distinguish which version of operator created it. | `` |