Skip to content

Commit

Permalink
Add support to scaffold controllers for External Types
Browse files Browse the repository at this point in the history
Introduces the option to allow users scaffold controllers for external types by running:

kubebuilder create api --group certmanager --version v1 --kind Certificate --controller=true --resource=false --make=false --external-api-path=github.com/cert-manager/cert-manager/pkg/apis/certmanager/v1
  • Loading branch information
camilamacedo86 committed Sep 21, 2024
1 parent c00db6e commit 7ea823d
Show file tree
Hide file tree
Showing 17 changed files with 386 additions and 297 deletions.
2 changes: 1 addition & 1 deletion docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
- [Manager and CRDs Scope](./reference/scopes.md)

- [Sub-Module Layouts](./reference/submodule-layouts.md)
- [Using an external Type / API](./reference/using_an_external_type.md)
- [Using an external Resource / API](./reference/using_an_external_resource.md)

- [Configuring EnvTest](./reference/envtest.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/reference/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
- [Platform Support](platform.md)

- [Sub-Module Layouts](submodule-layouts.md)
- [Using an external Type / API](using_an_external_type.md)
- [Using an external Resource / API](using_an_external_resource.md)

- [Metrics](metrics.md)
- [Reference](metrics-reference.md)
Expand Down
6 changes: 4 additions & 2 deletions docs/book/src/reference/submodule-layouts.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ This part describes how to modify a scaffolded project for use with multiple `go
Sub-Module Layouts (in a way you could call them a special form of [Monorepo's][monorepo]) are a special use case and can help in scenarios that involve reuse of APIs without introducing indirect dependencies that should not be available in the project consuming the API externally.

<aside class="note">
<h1>Using external Types</h1>
<h1>Using External Resources/APIs</h1>

If you are looking to do operations and reconcile via a controller a Type(CRD) which are owned by another project then, please see [Using an external Type](/reference/using_an_external_type.md) for more info.
If you are looking to do operations and reconcile via a controller a Type(CRD) which are owned by another project
or By Kubernetes API then, please see [Using an external Resources/API](/reference/using_an_external_type.md)
for more info.

</aside>

Expand Down
88 changes: 88 additions & 0 deletions docs/book/src/reference/using_an_external_resource.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# Using External Resources

In some cases, your project may need to work with resources that aren't defined by your own APIs.
These external resources fall into two main categories:

- **Core Types**: API types defined by Kubernetes itself, such as `Pods`, `Services`, and `Deployments`.
- **External Types**: API types defined in other projects, such as CRDs managed by another operator.

## Managing External Types

### Creating a Controller for External Types

To create a controller for an external type without scaffolding a resource, you can use the `create api` command with
the `--resource=false` option and specify the path to the external API type using the `--external-api-path` option.
This allows you to generate a controller that operates on types defined outside of your project, such as CRDs managed
by other operators.

The command looks like this:

```shell
kubebuilder create api --group <theirgroup> --version v1alpha1 --kind <ExternalTypeKind> --controller --resource=false --external-api-path=<Golang Import Path>
```

- `--external-api-path`: This is the import path for the external API type in your Go modules.
You should provide the Go import path where the external types are defined.

For example, if you're managing Certificates from Cert Manager:

```shell
kubebuilder create api --group certmanager --version v1 --kind Certificate --controller=true --resource=false --make=false --external-api-path=github.com/cert-manager/cert-manager/pkg/apis/certmanager/v1
```

This scaffolds a controller for the external type but skips creating new resource definitions since the type is defined in an external project.


### Creating a Webhooks to manage an external type

> Webhook support for external types is not currently available. (TODO)
## Managing Core Types

Core Kubernetes API types, such as `Pods`, `Services`, and `Deployments`, are predefined by Kubernetes.
To create a controller for these core types without scaffolding the resource, use the appropriate group for the type.

The following table lists the core groups and their corresponding API group paths.
Use this information when defining controllers for core Kubernetes resources.

| Group | API Group |
|--------------------------|-------------------------|
| admission | `k8s.io` |
| admissionregistration | `k8s.io` |
| apps | *(none)* |
| auditregistration | `k8s.io` |
| apiextensions | `k8s.io` |
| authentication | `k8s.io` |
| authorization | `k8s.io` |
| autoscaling | *(none)* |
| batch | *(none)* |
| certificates | `k8s.io` |
| coordination | `k8s.io` |
| core | *(none)* |
| events | `k8s.io` |
| extensions | *(none)* |
| imagepolicy | `k8s.io` |
| networking | `k8s.io` |
| node | `k8s.io` |
| metrics | `k8s.io` |
| policy | *(none)* |
| rbac.authorization | `k8s.io` |
| scheduling | `k8s.io` |
| setting | `k8s.io` |
| storage | `k8s.io` |

Use the group and API version specific to the type you're
managing when creating a controller for a core type.

The command for managing a core type looks like this:

```shell
kubebuilder create api --group core --version v1 --kind Pod --controller=true --resource=false
```

This scaffolds a controller for the Core type `corev1.Pod` but skips creating new resource
definitions since the type is defined in the Kubernetes API.

### Creating a Webhooks to manage a Core Type

> Webhook support for Core Types is not currently available. (TODO)
275 changes: 0 additions & 275 deletions docs/book/src/reference/using_an_external_type.md

This file was deleted.

Loading

0 comments on commit 7ea823d

Please sign in to comment.