You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/developer/getting_started.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -142,6 +142,21 @@ Wipe your deployment by running:
142
142
go run main.go --namespace sf dev wipe sf --rm-data
143
143
```
144
144
145
+
## Adding a new component
146
+
147
+
To add a new component to `sf-operator`, refer to the existing components in the `controllers` directory as a guide. These examples demonstrate how to:
148
+
149
+
* Define `Deployments` and `StatefulSets`.
150
+
* Mount `Volumes` using `Secrets`, `ConfigMaps`, and `PVCs`.
151
+
* Expose applications using `Routes` or `Ingresses`.
152
+
153
+
When creating a new component, aim for the existing implementations. The primary Kubernetes resource for the component **must** have the following annotations:
154
+
155
+
* `image`: The image name of the main application container.
156
+
* `serial`: A string-quoted number to identify the resource version.
157
+
* `config-hash`: A checksum of the configuration used by the main application container, if applicable.
158
+
159
+
145
160
## Next actions
146
161
147
162
Now that you have a testing environment set up, you may want to [run the test suite on your modifications](./testing.md).
0 commit comments