Skip to content

Commit c835b7f

Browse files
igor-karpukhinigor-karpukhin
authored
Initial commit for Scaffolder (#2697)
1 parent 64233d8 commit c835b7f

File tree

12 files changed

+1413
-0
lines changed

12 files changed

+1413
-0
lines changed

‎tools/scaffolder/LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎tools/scaffolder/Makefile‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
2+
build:
3+
go build -o bin/ako-controller-scaffolder cmd/main.go
4+
5+
generate:
6+
controller-gen object:headerFile="hack/boilerplate.go.txt" paths="./pkg/api/..."

‎tools/scaffolder/README.md‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
# Atlas Controller Scaffolder
2+
3+
A tool to generate Kubernetes controllers for MongoDB Atlas resources based on CRD configurations.
4+
5+
> [!WARNING]
6+
> This is the experimental tool. Bugs and issues are still present
7+
8+
## Overview
9+
10+
This scaffolder generates Kubernetes controllers that follow the MongoDB Atlas Kubernetes operator patterns, including:
11+
12+
- **State machine-based controllers** with proper lifecycle management
13+
- **Translation layers** for Atlas SDK integration
14+
- **Service interfaces** with appropriate Atlas API mappings
15+
- **License headers** and proper package structure
16+
17+
## Dependencies
18+
19+
### Required Local Repositories
20+
21+
The following repositories must be available locally in the parent directory:
22+
23+
```
24+
work/
25+
├── atlas-controller-scaffolder/ # This tool
26+
├── atlas2crd/ # Config definitions
27+
└── mongodb-atlas-kubernetes/ # Target operator
28+
```
29+
30+
### Setup
31+
32+
1. **Clone dependencies:**
33+
34+
```bash
35+
cd ../
36+
git clone https://github.com/mongodb-atlas-kubernetes/atlas2crd
37+
git clone https://github.com/mongodb/mongodb-atlas-kubernetes
38+
```
39+
40+
2. **Replace the crd2go dependency**
41+
Make sure the crd2go dependency is pointing to the local copy. In your `go.mod` file:
42+
43+
```bash
44+
replace github.com/josvazg/crd2go => ../crd2go
45+
```
46+
47+
3. **Generate CRD types**
48+
Use `crd2go` tool to generate go types for CRDs:
49+
50+
```bash
51+
cd ./crd2go/
52+
go build -o ./crd2go ./cmd/crd2go/main.go
53+
./crd2go -input=./pkg/crd2go/samples/crds.yaml -output=../atlas-controller-scaffolder/pkg/api/v1
54+
```
55+
56+
4. **Build the scaffolder:**
57+
```bash
58+
cd ../atlas-controller-scaffolder
59+
go build -o ./bin/ako-controller-scaffolder ./cmd/main.go
60+
```
61+
62+
63+
## Usage
64+
65+
### List Available CRDs
66+
67+
```bash
68+
./bin/ako-controller-scaffolder --config ../atlas2crd/config.yaml --list
69+
```
70+
71+
### Generate Controller
72+
73+
```bash
74+
./bin/ako-controller-scaffolder --config ../atlas2crd/config.yaml --crd <CRD_KIND>
75+
```
76+
77+
**Examples:**
78+
79+
```bash
80+
# Generate Team controller
81+
./bin/ako-controller-scaffolder --config ../atlas2crd/config.yaml --crd Team
82+
83+
# Generate Organization controller
84+
./bin/ako-controller-scaffolder --config ../atlas2crd/config.yaml --crd Organization
85+
86+
# Generate DatabaseUser controller
87+
./bin/ako-controller-scaffolder --config ../atlas2crd/config.yaml --crd DatabaseUser
88+
```
89+
90+
### Show Available CRDs
91+
92+
If you don't specify a CRD, the tool will show you all available options:
93+
94+
```bash
95+
./bin/ako-controller-scaffolder --config ../atlas2crd/config.yaml
96+
```
97+
98+
## Generated Structure
99+
100+
The tool generates controllers in the MongoDB Atlas Kubernetes operator directory:
101+
102+
```
103+
../mongodb-atlas-kubernetes/internal/
104+
├── controller/{crd_name}/
105+
│ ├── {crd_name}_controller.go # Main controller with reconciler
106+
│ └── handler.go # State handlers and setup
107+
└── translation/{crd_name}/
108+
├── {crd_name}.go # Translation types
109+
└── service.go # Atlas SDK service interface
110+
```
111+
112+
Generated controllers support all specified CRD versions. Translation layers stabs are generated per CRD version, using the Atlas SDK specified in the atlas2crd config file
113+
114+
## Features
115+
116+
- **Dynamic API Mapping** - Automatically selects correct Atlas SDK API
117+
- **State Machine Pattern** - Follows existing controller patterns
118+
- **Translation Layer** - Converts between Kubernetes and Atlas types
119+
- **License Headers** - Proper MongoDB license in all files
120+
- **RBAC Annotations** - Kubebuilder RBAC markers included
121+
- **Package Structure** - Consistent with existing codebase
122+
123+
## Available CRDs
124+
125+
Run with `--list` to see all available CRDs, including:
126+
127+
- Team, Organization, DatabaseUser
128+
- Cluster, FlexCluster, SearchIndex
129+
- BackupCompliancePolicy, DataFederation
130+
- NetworkPeeringConnection, CustomRole
131+
- And many more...
132+
133+
## Development
134+
135+
The scaffolder uses:
136+
137+
- **[Jennifer](https://github.com/dave/jennifer)** for Go code generation
138+
- **YAML parsing** for atlas2crd config files
139+
- **Atlas SDK mapping** for correct API selection

‎tools/scaffolder/cmd/main.go‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
package main
2+
3+
import (
4+
"fmt"
5+
"os"
6+
"tools/scaffolder/internal/generate"
7+
8+
"github.com/spf13/cobra"
9+
)
10+
11+
var (
12+
configPath string
13+
crdKind string
14+
listCRDs bool
15+
)
16+
17+
func main() {
18+
rootCmd := &cobra.Command{
19+
Use: "ako-controller-scaffolder",
20+
Short: "Generate Kubernetes controllers for MongoDB Atlas CRDs",
21+
RunE: func(cmd *cobra.Command, args []string) error {
22+
if configPath == "" {
23+
return fmt.Errorf("--config is required")
24+
}
25+
26+
if listCRDs {
27+
return generate.PrintCRDs(configPath)
28+
}
29+
30+
return generate.FromConfig(configPath, crdKind)
31+
},
32+
}
33+
34+
rootCmd.Flags().StringVar(&configPath, "config", "", "Path to atlas2crd config file (required)")
35+
rootCmd.Flags().StringVar(&crdKind, "crd", "", "CRD kind to generate controller for")
36+
rootCmd.Flags().BoolVar(&listCRDs, "list", false, "List available CRDs from config file")
37+
38+
if err := rootCmd.Execute(); err != nil {
39+
fmt.Fprintf(os.Stderr, "Error: %v\n", err)
40+
os.Exit(1)
41+
}
42+
}

0 commit comments

Comments
 (0)