Initial commit for Controller Scaffolder #2697

igor-karpukhin · 2025-09-16T15:05:06Z

Summary

Initial commit for Controller Scaffolder

Proof of Work

Checklist

Have you linked a jira ticket and/or is the ticket in the title?
Have you checked whether your jira ticket required DOCSP changes?
Have you checked for release_note changes?
Have you signed our CLA?

josvazg · 2025-09-16T15:33:40Z

tools/scaffolder/README.md

+This scaffolder generates Kubernetes controllers that follow the MongoDB Atlas Kubernetes operator patterns, including:
+
+- **State machine-based controllers** with proper lifecycle management
+- **Translation layers** for Atlas SDK integration


q: This is wired, maybe, but not generated right?

josvazg · 2025-09-16T15:34:07Z

tools/scaffolder/README.md

+
+- **State machine-based controllers** with proper lifecycle management
+- **Translation layers** for Atlas SDK integration
+- **Service interfaces** with appropriate Atlas API mappings


q: With runtime translations, this is basically SDKClient management right?

josvazg · 2025-09-16T15:34:51Z

tools/scaffolder/README.md

+├── atlas-controller-scaffolder/    # This tool
+├── atlas2crd/                      # Config definitions


q: Do these path change once integrated on the AKO repo?

josvazg · 2025-09-16T15:36:06Z

tools/scaffolder/README.md

+1. **Clone dependencies:**
+
+   ```bash
+   cd ../
+   git clone https://github.com/mongodb-atlas-kubernetes/atlas2crd
+   git clone https://github.com/mongodb/mongodb-atlas-kubernetes
+   ```


q: we might not need this anymore, so long as you are working in the AKO repo, right?

josvazg · 2025-09-16T15:37:13Z

tools/scaffolder/README.md

+2. **Replace the crd2go dependency**
+   Make sure the crd2go dependency is pointing to the local copy. In your `go.mod` file:
+
+   ```bash
+   replace github.com/josvazg/crd2go => ../crd2go
+   ```


This will be just be a dependency on the open source repo, once available. It can now already be used a a library, once the deps got fixed.

josvazg · 2025-09-16T15:38:36Z

tools/scaffolder/README.md

+3. **Generate CRD types**
+    Use `crd2go` tool to generate go types for CRDs:
+
+    ```bash
+    cd ./crd2go/
+    go build -o ./crd2go ./cmd/crd2go/main.go
+    ./crd2go -input=./pkg/crd2go/samples/crds.yaml -output=../atlas-controller-scaffolder/pkg/api/v1
+    ```


🎉 thanks! so do don't need to document it myself ;-p

This doc is very good I shall do a similar one for CRD2Go before it gets its own repo.

josvazg · 2025-09-16T15:39:42Z

tools/scaffolder/README.md

+### List Available CRDs
+
+```bash
+./bin/ako-controller-scaffolder --config ../atlas2crd/config.yaml --list
+```
+
+### Generate Controller
+
+```bash
+./bin/ako-controller-scaffolder --config ../atlas2crd/config.yaml --crd <CRD_KIND>
+```
+
+**Examples:**
+
+```bash
+# Generate Team controller
+./bin/ako-controller-scaffolder --config ../atlas2crd/config.yaml --crd Team
+
+# Generate Organization controller
+./bin/ako-controller-scaffolder --config ../atlas2crd/config.yaml --crd Organization
+
+# Generate DatabaseUser controller
+./bin/ako-controller-scaffolder --config ../atlas2crd/config.yaml --crd DatabaseUser


q: these refer to the config, but will they actually be the CRDs produced?

josvazg · 2025-09-16T15:40:34Z

tools/scaffolder/README.md

+    └── service.go                 # Atlas SDK service interface
+```
+
+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


typo?

Suggested change

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

Generated controllers support all specified CRD versions. Translation layers stubs are generated per CRD version, using the Atlas SDK specified in the atlas2crd config file

josvazg · 2025-09-16T15:41:31Z

tools/scaffolder/README.md

+
+- **Dynamic API Mapping** - Automatically selects correct Atlas SDK API
+- **State Machine Pattern** - Follows existing controller patterns
+- **Translation Layer** - Converts between Kubernetes and Atlas types


q: we were leaving this to the user and the translation lib right?

josvazg · 2025-09-16T15:48:16Z

tools/scaffolder/internal/generate/config.go

+type Config struct {
+	metav1.TypeMeta `yaml:",inline"`
+	Spec            Spec `yaml:"spec"`
+}
+
+type Spec struct {
+	OpenAPI []OpenAPIConfig `yaml:"openapi,omitempty"`
+	CRD     []CRDConfig     `yaml:"crd,omitempty"`
+}
+
+type OpenAPIConfig struct {
+	Name    string `yaml:"name"`
+	Package string `yaml:"package"`
+}
+
+type CRDConfig struct {
+	GVK        metav1.GroupVersionKind `yaml:"gvk"`
+	Categories []string                `yaml:"categories,omitempty"`
+	ShortNames []string                `yaml:"shortNames,omitempty"`
+	Mappings   []Mapping               `yaml:"mappings,omitempty"`
+}
+
+type Mapping struct {
+	MajorVersion string      `yaml:"majorVersion"`
+	OpenAPIRef   OpenAPIRef  `yaml:"openAPIRef"`
+	Parameters   *Parameters `yaml:"parameters,omitempty"`
+	Entry        *SchemaRef  `yaml:"entry,omitempty"`
+	Status       *SchemaRef  `yaml:"status,omitempty"`
+}
+
+type OpenAPIRef struct {
+	Name string `yaml:"name"`
+}
+
+type Parameters struct {
+	Path       *PathInfo     `yaml:"path,omitempty"`
+	Query      []QueryParam  `yaml:"query,omitempty"`
+	Additional []interface{} `yaml:"additional,omitempty"`
+}
+
+type PathInfo struct {
+	Template string `yaml:"template"`
+}
+
+type QueryParam struct {
+	Name  string `yaml:"name"`
+	Value string `yaml:"value"`
+}
+
+type SchemaRef struct {
+	Schema string `yaml:"$ref"`
+}
+
+// MappingWithConfig combines mapping with its OpenAPI config
+type MappingWithConfig struct {
+	Mapping       Mapping
+	OpenAPIConfig OpenAPIConfig
+}
+
+// ParsedConfig contains all parsed configuration data
+type ParsedConfig struct {
+	Config       Config
+	OpenAPIMap   map[string]OpenAPIConfig
+	CRDMap       map[string]CRDConfig
+	SelectedCRD  CRDConfig
+	Mappings     []MappingWithConfig
+	ResourceName string
+}


Most of these types are to be able to parse the CRD inputs right?

I was doing the same, then @s-urbaniak pointed me to the kube library that already supports all this. You can use that instead.

See:
https://github.com/mongodb/mongodb-atlas-kubernetes/blob/main/tools/crd2go/internal/crd/parse.go#L27

You want *apiextensionsv1.CustomResourceDefinition from:

import apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"

josvazg

LGTM, but please take the comments into account for follow up

Initial commit for Scaffolder

c62cde0

igor-karpukhin requested a review from a team as a code owner September 16, 2025 15:05

josvazg reviewed Sep 16, 2025

View reviewed changes

josvazg approved these changes Sep 16, 2025

View reviewed changes

igor-karpukhin merged commit c835b7f into main Sep 16, 2025
21 of 22 checks passed

igor-karpukhin deleted the feature/controller-scaffolder branch September 16, 2025 16:19

igor-karpukhin temporarily deployed to release September 16, 2025 16:19 — with GitHub Actions Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial commit for Controller Scaffolder #2697

Initial commit for Controller Scaffolder #2697

Uh oh!

igor-karpukhin commented Sep 16, 2025

Uh oh!

josvazg Sep 16, 2025 •

edited

Loading

Uh oh!

josvazg Sep 16, 2025 •

edited

Loading

Uh oh!

josvazg Sep 16, 2025 •

edited

Loading

Uh oh!

josvazg Sep 16, 2025

Uh oh!

josvazg Sep 16, 2025

Uh oh!

josvazg Sep 16, 2025

Uh oh!

josvazg Sep 16, 2025

Uh oh!

josvazg Sep 16, 2025

Uh oh!

josvazg Sep 16, 2025

Uh oh!

josvazg Sep 16, 2025

Uh oh!

josvazg left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		├── atlas-controller-scaffolder/ # This tool
		├── atlas2crd/ # Config definitions

	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
	Generated controllers support all specified CRD versions. Translation layers stubs are generated per CRD version, using the Atlas SDK specified in the atlas2crd config file

Initial commit for Controller Scaffolder #2697

Initial commit for Controller Scaffolder #2697

Uh oh!

Conversation

igor-karpukhin commented Sep 16, 2025

Summary

Proof of Work

Checklist

Uh oh!

josvazg Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

josvazg Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

josvazg Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

josvazg Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

josvazg Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

josvazg Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

josvazg Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

josvazg Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

josvazg Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

josvazg Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

josvazg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

josvazg Sep 16, 2025 •

edited

Loading

josvazg Sep 16, 2025 •

edited

Loading

josvazg Sep 16, 2025 •

edited

Loading