We are thrilled to introduce a new, Gemini-powered approach for adding Config Connector resources and fields. This workflow automates the most complex parts of the development process, making it significantly faster and more reliable.
We now support two development workflows:
This is the recommended and most efficient way to develop KCC resources. In this workflow, you will use the Gemini CLI to perform the implementation steps, while your role is to provide high-level prompts and verify the results.
Get started with the AI-Assisted Workflow
This is the original, manual process for developing direct resources. This approach is more time-consuming and requires a deeper understanding of the KCC codebase, but it gives you full control over every step of the implementation.
Get started with the Manual Workflow
The following documents provide the technical foundation for the direct reconciliation framework. They are essential for verifying the work of the AI in the assisted workflow, and for guiding the implementation in the manual workflow.
This diagram gives a concise overview of the direct reconciliation approach. It offers a high-level perspective, showing the relationship between key components.
The guide will walk you through adding each component (yellow box) using the Config Connector code-generation tools. The generated code will offer greater insight into the functionality of each component. You might need to adjust the generated code to accommodate specific resource or GCP service requirements (for example, resources that don't allow user creation or aren't fully declarative as described in https://google.aip.dev/128).
Familiarity with Kubernetes is not required to develop Config Connector resources. However, if you're interested in learning more about Kubernetes CRDs or Controllers (blue box), please refer to https://kubernetes.io/.
The scenarios section lists all the common scenarios you may want to contribute to Config Connector. Each scenario contains the tools and guided steps to establish your task. We recommend you use the following principles to find the scenario best suite your case, and get started from there.
-
Check the CRD: Examine the latest CRDs. The version can be found from the file name. If the resource exists but is in Alpha (and therefore not yet in the Config Connector API Reference), follow the Alpha to Beta promotion guide. This may be the simplest solution.
-
File an issue (if no CRD exists): If no CRD is found, you'll likely need to create a new resource. Before starting this process, check if an issue is already filed. If not, please file an issue to avoid duplication of effort and allow us to coordinate effectively. If you are willing to take the resource yourself, please assign the issue.
-
Prioritize the direct approach: We are currently prioritizing the Direct approach over Terraform/DCL-based resource implementations. If you encounter issues preventing the use of the direct approach, please let us know in the filed issue so we can assist.
The api-conventions section is topic specific and focus on the Config Connector's solution on that topic.
The deep-dives section gives you all the tools and exit criteria for a given step in each scenario. You may not need all of them to establish your task.
- Add a new resource
- Add a new field
- Promote a Alpha Resource to Beta
- Migrate a Terraform/DCL-based Resource to Direct (Alpha)
- Migrate a Terraform/DCL-based Resource to Direct (Beta)
This section gives a deep-dive about each step.