Skip to content

Commit 3fabbf5

Browse files
committed
Fix README
1 parent ca0e9c6 commit 3fabbf5

File tree

1 file changed

+47
-37
lines changed

1 file changed

+47
-37
lines changed

operator/README.md

Lines changed: 47 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
# operator
22

3-
FunctionStream Operator is a Kubernetes operator designed to manage custom resources for serverless function orchestration and package management on Kubernetes clusters.
3+
FunctionStream Operator is a Kubernetes operator designed to manage custom resources for serverless function
4+
orchestration and package management on Kubernetes clusters.
45

56
## Description
67

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.
8+
This project provides a Kubernetes operator that automates the lifecycle of custom resources such as Functions and
9+
Packages. It enables users to define, deploy, and manage serverless functions and their dependencies using
10+
Kubernetes-native APIs. The operator ensures that the desired state specified in custom resources is reflected in the
11+
actual cluster state, supporting extensibility and integration with cloud-native workflows.
812

913
## Deploying with Helm Chart
1014

11-
The recommended way to deploy the FunctionStream Operator is using the provided Helm chart. This method simplifies installation, upgrades, and configuration management.
15+
The recommended way to deploy the FunctionStream Operator is using the provided Helm chart. This method simplifies
16+
installation, upgrades, and configuration management.
1217

1318
### Prerequisites
1419

@@ -33,20 +38,25 @@ The recommended way to deploy the FunctionStream Operator is using the provided
3338
This will install the operator in the `fs` namespace with the release name `fs`.
3439

3540
3. **(Optional) Customize your deployment:**
36-
- You can override default values by editing `deploy/chart/values.yaml`, by providing your own values file, or by using the `--set` flag.
37-
- To use your own values file:
38-
```sh
39-
helm install fs ./deploy/chart \
40-
--namespace fs --create-namespace \
41-
-f my-values.yaml
42-
```
43-
- To override values from the command line:
44-
```sh
45-
helm install fs ./deploy/chart \
46-
--namespace fs \
47-
--set controllerManager.replicas=2
48-
```
49-
- For a full list of configurable options, see [`deploy/chart/values.yaml`](deploy/chart/values.yaml).
41+
- You can override default values by editing `deploy/chart/values.yaml`, by providing your own values file, or by
42+
using the `--set` flag.
43+
- To use your own values file:
44+
45+
```sh
46+
helm install fs ./deploy/chart \
47+
--namespace fs --create-namespace \
48+
-f my-values.yaml
49+
```
50+
51+
- To override values from the command line:
52+
53+
```sh
54+
helm install fs ./deploy/chart \
55+
--namespace fs \
56+
--set controllerManager.replicas=2
57+
```
58+
59+
- For a full list of configurable options, see [`deploy/chart/values.yaml`](deploy/chart/values.yaml).
5060

5161
### Upgrading
5262

@@ -65,7 +75,8 @@ To uninstall the operator and all associated resources:
6575
helm uninstall fs --namespace fs
6676
```
6777

68-
> **Note:** By default, CRDs are retained after uninstall. You can control this behavior via the `crd.keep` value in `values.yaml`.
78+
> **Note:** By default, CRDs are retained after uninstall. You can control this behavior via the `crd.keep` value in
79+
`values.yaml`.
6980

7081
## Getting Started
7182

@@ -101,7 +112,7 @@ make deploy IMG=<some-registry>/operator:tag
101112
```
102113
103114
> **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin
104-
privileges or be logged in as admin.
115+
> privileges or be logged in as admin.
105116
106117
**Create instances of your solution**
107118
You can apply the samples (examples) from the config/sample:
@@ -110,7 +121,7 @@ You can apply the samples (examples) from the config/sample:
110121
kubectl apply -k config/samples/
111122
```
112123
113-
>**NOTE**: Ensure that the samples has default values to test it out.
124+
> **NOTE**: Ensure that the samples has default values to test it out.
114125
115126
### To Uninstall
116127
@@ -140,34 +151,34 @@ Following the options to release and provide this solution to the users.
140151
141152
1. Build the installer for the image built and published in the registry:
142153
143-
```sh
144-
make build-installer IMG=<some-registry>/operator:tag
145-
```
154+
```sh
155+
make build-installer IMG=<some-registry>/operator:tag
156+
```
146157
147-
**NOTE:** The makefile target mentioned above generates an 'install.yaml'
148-
file in the dist directory. This file contains all the resources built
149-
with Kustomize, which are necessary to install this project without its
150-
dependencies.
158+
**NOTE:** The makefile target mentioned above generates an 'install.yaml'
159+
file in the dist directory. This file contains all the resources built
160+
with Kustomize, which are necessary to install this project without its
161+
dependencies.
151162
152163
2. Using the installer
153164
154-
Users can just run 'kubectl apply -f <URL for YAML BUNDLE>' to install
155-
the project, i.e.:
165+
Users can just run 'kubectl apply -f <URL for YAML BUNDLE>' to install
166+
the project, i.e.:
156167
157-
```sh
158-
kubectl apply -f https://raw.githubusercontent.com/<org>/operator/<tag or branch>/dist/install.yaml
159-
```
168+
```sh
169+
kubectl apply -f https://raw.githubusercontent.com/<org>/operator/<tag or branch>/dist/install.yaml
170+
```
160171
161172
### By providing a Helm Chart
162173
163174
1. Build the chart using the optional helm plugin
164175
165-
```sh
166-
kubebuilder edit --plugins=helm/v1-alpha
167-
```
176+
```sh
177+
kubebuilder edit --plugins=helm/v1-alpha
178+
```
168179
169180
2. See that a chart was generated under 'dist/chart', and users
170-
can obtain this solution from there.
181+
can obtain this solution from there.
171182
172183
**NOTE:** If you change the project, you need to update the Helm Chart
173184
using the same command above to sync the latest changes. Furthermore,
@@ -176,7 +187,6 @@ the '--force' flag and manually ensure that any custom configuration
176187
previously added to 'dist/chart/values.yaml' or 'dist/chart/manager/manager.yaml'
177188
is manually re-applied afterwards.
178189
179-
180190
**NOTE:** Run `make help` for more information on all potential `make` targets
181191
182192
More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)

0 commit comments

Comments
 (0)