@@ -5,25 +5,24 @@ Here are a few things to go over before getting started with CodeFlare Operator
5
5
## Environment setup
6
6
7
7
The following should be installed in your working environment:
8
- installation/)
9
8
- Go 1.18.X
10
9
- [ Download release] ( https://go.dev/dl/ )
11
10
- [ Install Instructions] ( https://go.dev/doc/install )
12
11
- [ Operator SDK] ( https://sdk.operatorframework.io/docs/installation/ )
13
12
- GCC
14
13
15
14
## Basic Overview
16
- Under the ` api ` dir, the MCAD and InstaScale custom resources are defined:
15
+ The main entrypoint for the operator is ` main.go `
16
+
17
+ The MCAD and InstaScale custom resources are defined under the ` api ` dir:
17
18
- See ` mcad_types.go ` and ` instascale_types.go `
18
19
19
- Under ` config/internal ` are where the MCAD and InstaScale resource templates can be found:
20
+ The MCAD and InstaScale resource templates can be found under ` config/internal ` :
20
21
- Sorted under ` mcad ` and ` insascale ` subdirs
21
22
22
- The code for MCAD/InstaScale resource reconsilliation can be found in the ` controllers ` dir:
23
+ The code for MCAD/InstaScale resource reconcilliation can be found in the ` controllers ` dir:
23
24
- See ` mcad_controller.go ` and ` instascale_controller.go `
24
25
25
- The main entrypoint for the operator is ` main.go `
26
-
27
26
## Building and Deployment
28
27
If changes are made in the ` api ` dir, run: ` make manifests `
29
28
- This will generate new CRDs and associated files
@@ -44,6 +43,7 @@ For deploying onto a cluster:
44
43
The CodeFlare Operator currently has unit tests and pre-commit checks
45
44
- To enable and view pre-commit checks: ` pre-commit install `
46
45
- To run unit tests, run ` make test-unit `
46
+ - Note that both are required for CI to pass on pull requests
47
47
48
48
To write and inspect unit tests:
49
49
- MCAD and InstaScale unit tests under ` mcad_controller_test.go ` and ` instascale_controller_test.go ` in the ` controllers ` dir
0 commit comments