Skip to content

Commit daecac4

Browse files
Microzuul CIGerrit Code Review
authored andcommitted
Merge "Add developer documentation to add a new component"
2 parents f33ed23 + 0c29c6f commit daecac4

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

doc/developer/getting_started.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,21 @@ Wipe your deployment by running:
142142
go run main.go --namespace sf dev wipe sf --rm-data
143143
```
144144

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+
145160
## Next actions
146161

147162
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

Comments
 (0)