Skip to content

Commit ca41f4e

Browse files
committed
Update README
1 parent 5f724f7 commit ca41f4e

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

operator/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# operator
2-
// TODO(user): Add simple overview of use/purpose
2+
3+
FunctionStream Operator is a Kubernetes operator designed to manage custom resources for serverless function orchestration and package management on Kubernetes clusters.
34

45
## Description
5-
// TODO(user): An in-depth paragraph about your project and overview of use
6+
7+
This project provides a Kubernetes operator that automates the lifecycle of custom resources such as Functions and Packages. It enables users to define, deploy, and manage serverless functions and their dependencies using Kubernetes-native APIs. The operator ensures that the desired state specified in custom resources is reflected in the actual cluster state, supporting extensibility and integration with cloud-native workflows.
68

79
## Getting Started
810

@@ -21,7 +23,7 @@ make docker-build docker-push IMG=<some-registry>/operator:tag
2123

2224
**NOTE:** This image ought to be published in the personal registry you specified.
2325
And it is required to have access to pull the image from the working environment.
24-
Make sure you have the proper permission to the registry if the above commands dont work.
26+
Make sure you have the proper permission to the registry if the above commands don't work.
2527

2628
**Install the CRDs into the cluster:**
2729

operator/config/samples/fs_v1alpha1_function.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,8 @@ metadata:
66
app.kubernetes.io/managed-by: kustomize
77
name: function-sample
88
spec:
9+
displayName: "Sample Function"
10+
description: "A sample function for demonstration purposes."
11+
package: "sample-package"
12+
module: "sample-module"
913
# TODO(user): Add fields here

0 commit comments

Comments
 (0)