Serverless Operator

Status

Overview

Serverless Operator allows deploying the Serverless component on the Kyma cluster in compatibility with Lifecycle Manager.

Install

Apply the following script to install Serverless Operator:

kubectl apply -f https://github.com/kyma-project/serverless-manager/releases/latest/download/serverless-operator.yaml

To get Serverless installed, apply the sample Serverless CR:

kubectl apply -f https://github.com/kyma-project/serverless-manager/releases/latest/download/default_serverless_cr.yaml

Development

Prerequisites

• Access to a Kubernetes (v1.24 or higher) cluster
• Go
• k3d
• Docker
• kubectl
• Kubebuilder

Manual installation using make targets

1. Clone the project.

   git clone https://github.com/kyma-project/serverless-manager.git && cd serverless-manager/
   

2. Set the Serverless Operator image name.

   export IMG=<DOCKER_USERNAME>/custom-serverless-operator:0.0.1
   

3. Verify the compability.

   make test
   

4. Build and push the image to the registry.

   make module-image
   

5. Deploy Serverless Operator.

   make deploy
   

Test integration with Lifecycle Manager on the k3d cluster

1. Clone the project.

   git clone https://github.com/kyma-project/serverless-manager.git && cd serverless-manager/
   

2. Build Serverless Operator locally and run it on the k3d cluster.

   make -C hack/local run-with-lifecycle-manager
   

NOTE: To clean up the k3d cluster, use the make -C hack/local stop make target.

Using Serverless Operator

• Create a Serverless instance.

  kubectl apply -f config/samples/default_serverless_cr.yaml
  

• Delete a Serverless instance.

  kubectl delete -f config/samples/default_serverless_cr.yaml
  

• Use external registry.

  The following example shows how you can modify the Serverless docker registry address using the serverless.operator.kyma-project.io CR:

  kubectl create secret generic my-secret \
      --namespace kyma-system \
      --from-literal username="<USERNAME>" \
      --from-literal password="<PASSWORD>" \
      --from-literal serverAddress="<SERVER_ADDRESS>" \
      --from-literal registryAddress="<REGISTRY_ADDRESS>"
  

  NOTE: For DockerHub:

  • SERVER_ADDRESS is "https://index.docker.io/v1/",
  • USERNAME and REGISTRY_ADDRESS must be identical.

  cat <<EOF | kubectl apply -f -
  apiVersion: operator.kyma-project.io/v1alpha1
  kind: Serverless
  metadata:
  name: serverless-sample
  spec:
      dockerRegistry:
          enableInternal: false
          secretName: my-secret
  EOF