Skip to content

Commit 1ea16af

Browse files
madornhasbro17
authored andcommitted
doc/user-guide: Update 3rd Party Resources User-Guide Info (#761)
Document Core Kubernetes resources that are automatically registered and update 3rd Party Resource example to reflect a scheme that is not registered "out-of-the-box".
1 parent acb5dbe commit 1ea16af

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

doc/user-guide.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@ $ kubectl delete -f deploy/service_account.yaml
355355

356356
### Adding 3rd Party Resources To Your Operator
357357

358-
By default the operator's Manager will register all custom resource types defined in your project under `pkg/apis` with its scheme.
358+
The operator's Manager supports the Core Kubernetes resource types as found in the client-go [scheme][scheme_package] package and will also register the schemes of all custom resource types defined in your project under `pkg/apis`.
359359
```Go
360360
import (
361361
"github.com/example-inc/memcached-operator/pkg/apis"
@@ -377,18 +377,20 @@ Example:
377377
```go
378378
import (
379379
....
380-
appsv1 "k8s.io/api/apps/v1"
380+
routev1 "github.com/openshift/api/route/v1"
381381
)
382382

383383
func main() {
384384
....
385-
if err := appsv1.AddToScheme(mgr.GetScheme()); err != nil {
385+
if err := routev1.AddToScheme(mgr.GetScheme()); err != nil {
386386
log.Fatal(err)
387387
}
388388
....
389389
}
390390
```
391391

392+
After adding new import paths to your operator project, run `dep ensure` in the root of your project directory to fulfill these dependencies.
393+
392394
[memcached_handler]: ../example/memcached-operator/handler.go.tmpl
393395
[memcached_controller]: ../example/memcached-operator/memcached_controller.go.tmpl
394396
[layout_doc]:./project_layout.md
@@ -399,6 +401,7 @@ func main() {
399401
[docker_tool]:https://docs.docker.com/install/
400402
[kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
401403
[minikube_tool]:https://github.com/kubernetes/minikube#installation
404+
[scheme_package]:https://github.com/kubernetes/client-go/blob/master/kubernetes/scheme/register.go
402405
[deployments_register]: https://github.com/kubernetes/api/blob/master/apps/v1/register.go#L41
403406
[doc_client_api]:./user/client.md
404407
[runtime_package]: https://godoc.org/k8s.io/apimachinery/pkg/runtime

0 commit comments

Comments
 (0)