Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cmd/operator-sdk/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ func main() {
if operatorType == projutil.OperatorTypeGo {
depMsg := "Operator SDK has a new CLI and project layout that is aligned with Kubebuilder.\n" +
"See `operator-sdk init -h` and the following doc on how to scaffold a new project:\n" +
"https://sdk.operatorframework.io/docs/golang/new/quickstart/\n" +
"https://sdk.operatorframework.io/docs/golang/quickstart/\n" +
"To migrate existing projects to the new layout see:\n" +
"https://sdk.operatorframework.io/docs/golang/new/migration/project_migration_guide/\n"
"https://sdk.operatorframework.io/docs/golang/migration/project_migration_guide/\n"
projutil.PrintDeprecationWarning(depMsg)
}
if err := cli.RunLegacy(); err != nil {
Expand Down
2 changes: 1 addition & 1 deletion internal/util/projutil/project_util.go
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ func CheckGoModules() error {
}
if !goModOn {
return fmt.Errorf(`using go modules requires GO111MODULE="on", "auto", or unset.` +
` More info: https://sdk.operatorframework.io/docs/golang/new/quickstart/#a-note-on-dependency-management`)
` More info: https://sdk.operatorframework.io/docs/golang/quickstart/#a-note-on-dependency-management`)
}
return nil
}
Expand Down
2 changes: 1 addition & 1 deletion proposals/leader-for-life.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Implementation Owner:

> Status: **implemented**
>
> See [leader election documentation](https://sdk.operatorframework.io/docs/golang/new/advanced-topics/#leader-election).
> See [leader election documentation](https://sdk.operatorframework.io/docs/golang/advanced-topics/#leader-election).

- [Background](#background)
- [Goals](#goals)
Expand Down
2 changes: 1 addition & 1 deletion website/content/en/build/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ <h2 class="of-heading of-heading--xl">READ THE USER GUIDES</h2>
<path d="M19.5,8l-7.3-7.6c-0.4-0.4-1.1-0.4-1.5,0L9.3,1.8c-0.4,0.4-0.4,1.1,0,1.6l5.2,5.5H1.1C0.5,8.9,0,9.3,0,10V12 c0,0.6,0.5,1.1,1.1,1.1h13.5l-5.2,5.5c-0.4,0.4-0.4,1.1,0,1.6l1.4,1.5c0.4,0.4,1.1,0.4,1.5,0l9.4-9.9c0.4-0.4,0.4-1.1,0-1.6L19.5,8z "/>
</svg>
</a></li>
<li><a href="/docs/golang/new/quickstart/" class="of-button of-button--tertiary">
<li><a href="/docs/golang/quickstart/" class="of-button of-button--tertiary">
Go Quickstart
<svg class="of-button__icon" enable-background="new 0 0 22 22" version="1.1" viewBox="0 0 22 22" xml:space="preserve" xmlns="http://www.w3.org/2000/svg">
<path d="M19.5,8l-7.3-7.6c-0.4-0.4-1.1-0.4-1.5,0L9.3,1.8c-0.4,0.4-0.4,1.1,0,1.6l5.2,5.5H1.1C0.5,8.9,0,9.3,0,10V12 c0,0.6,0.5,1.1,1.1,1.1h13.5l-5.2,5.5c-0.4,0.4-0.4,1.1,0,1.6l1.4,1.5c0.4,0.4,1.1,0.4,1.5,0l9.4-9.9c0.4-0.4,0.4-1.1,0-1.6L19.5,8z "/>
Expand Down
2 changes: 1 addition & 1 deletion website/content/en/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Operator SDK is under Apache 2.0 license. See the [LICENSE][license_file] file f
[controller_runtime]: https://github.com/kubernetes-sigs/controller-runtime
[faq]: /docs/faq/
[getting_started]: https://github.com/operator-framework/getting-started/blob/master/README.md
[golang-guide]:/docs/golang/new/quickstart/
[golang-guide]:/docs/golang/quickstart/
[helm-guide]:/docs/helm/quickstart/
[install_guide]: /docs/install-operator-sdk/
[license_file]:https://github.com/operator-framework/operator-sdk/blob/master/LICENSE
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,4 @@ The Go, Ansible, and Helm tests then differ in what tests they run.
[ansible-test]: https://github.com/operator-framework/operator-sdk/tree/master/test/ansible
[helm-e2e]: https://github.com/operator-framework/operator-sdk/blob/master/hack/tests/e2e-helm.sh
[helm-base]: https://github.com/operator-framework/operator-sdk/blob/master/hack/image/helm/scaffold-helm-image.go
[deps_mgmt]: ../../../golang/new/quickstart#a-note-on-dependency-management
[deps_mgmt]: /docs/golang/legacy/quickstart#a-note-on-dependency-management
2 changes: 1 addition & 1 deletion website/content/en/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ This will work for the current environment. To persist this fix, add the above l

[kube-apiserver_options]: https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/#options
[controller-runtime_faq]: https://github.com/kubernetes-sigs/controller-runtime/blob/master/FAQ.md#q-how-do-i-have-different-logic-in-my-reconciler-for-different-types-of-events-eg-create-update-delete
[finalizer]:/docs/golang/new/advanced-topics/#handle-cleanup-on-deletion
[finalizer]:/docs/golang/advanced-topics/#handle-cleanup-on-deletion
[gc-metrics]:/docs/golang/legacy/monitoring/prometheus/#garbage-collection
[cr-faq]:https://github.com/kubernetes-sigs/controller-runtime/blob/master/FAQ.md
[client.Reader]:https://godoc.org/sigs.k8s.io/controller-runtime/pkg/client#Reader
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,5 +97,5 @@ spec:
```

[RBAC]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/
[manager_user_guide]:/docs/golang/new/quickstart/#manager
[manager_user_guide]:/docs/golang/quickstart/#manager
[manager_options]: https://godoc.org/github.com/kubernetes-sigs/controller-runtime/pkg/manager#Options
4 changes: 2 additions & 2 deletions website/content/en/docs/golang/legacy/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: Golang Based Operators - Legacy CLI
weight: 200
title: Legacy CLI and Project Layout
weight: 300
---
2 changes: 1 addition & 1 deletion website/content/en/docs/golang/legacy/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -861,5 +861,5 @@ When the operator is not running in a cluster, the Manager will return an error
[typical-status-properties]: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties
[godoc-conditions]: https://godoc.org/github.com/operator-framework/operator-sdk/pkg/status#Conditions
[olm-user-guide]: /docs/olm-integration/user-guide
[new_docs]:/docs/golang/new/quickstart
[new_docs]:/docs/golang/quickstart
[new_CLI]:/docs/new-cli
4 changes: 0 additions & 4 deletions website/content/en/docs/golang/new/_index.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -269,5 +269,5 @@ if strings.Contains(namespace, ",") {
[k8s-rbac]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/
[kube-rbac-proxy]: https://github.com/brancz/kube-rbac-proxy
[rbac-clusterrole]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/#role-and-clusterrole
[crd-scope-doc]: /docs/golang/new/crds-scope/
[crd-scope-doc]: /docs/golang/crds-scope/
[rbac-markers]: https://book.kubebuilder.io/reference/markers/rbac.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Migrating Legacy Projects
linkTitle: Migrating Legacy Projects
weight: 300
weight: 200
---

# Overview
Expand Down Expand Up @@ -155,7 +155,7 @@ To update `config/rbac/role.yaml` after changing the markers, run `make manifest
The project can now be built and the operator can be deployed on cluster. For further steps regarding the deployment of operator, creation of custom resource and cleaning up of resources, refer to [quickstart guide][kb_quickstart].


[memcached-operator]:/docs/golang/new/quickstart/
[memcached-operator]:/docs/golang/quickstart/
[git_tool]: https://git-scm.com/downloads
[go_tool]: https://golang.org/dl/
[kubectl_tool]: https://github.com/kubernetes/minikube#installation
Expand All @@ -169,5 +169,5 @@ The project can now be built and the operator can be deployed on cluster. For fu
[memcached_cr]: https://github.com/operator-framework/operator-sdk-samples/blob/master/go/memcached-operator/deploy/crds/cache.example.com_v1alpha1_memcached_cr.yaml
[memcached_types]: https://github.com/operator-framework/operator-sdk-samples/blob/master/go/memcached-operator/pkg/apis/cache/v1alpha1/memcached_types.go
[kb_memcached_controller]: https://github.com/operator-framework/operator-sdk/blob/master/example/kb-memcached-operator/memcached_controller.go.tmpl
[kb_quickstart]: /docs/golang/new/quickstart/
[kb_quickstart]: /docs/golang/quickstart/
[install_guide]: /docs/install-operator-sdk/
Original file line number Diff line number Diff line change
Expand Up @@ -457,16 +457,16 @@ Also see the [advanced topics][advanced_topics] doc for more use cases and under

[enqueue_requests_from_map_func]: https://godoc.org/sigs.k8s.io/controller-runtime/pkg/handler#EnqueueRequestsFromMapFunc
[event_handler_godocs]: https://godoc.org/sigs.k8s.io/controller-runtime/pkg/handler#hdr-EventHandlers
[event_filtering]:/docs/golang/new/references/event-filtering/
[event_filtering]:/docs/golang/references/event-filtering/
[controller_options]: https://godoc.org/github.com/kubernetes-sigs/controller-runtime/pkg/controller#Options
[controller_godocs]: https://godoc.org/github.com/kubernetes-sigs/controller-runtime/pkg/controller
[operator_scope]:/docs/golang/new/operator-scope/
[operator_scope]:/docs/golang/operator-scope/
[memcached_handler]: ../example/memcached-operator/handler.go.tmpl
[kubebuilder_layout_doc]:https://book.kubebuilder.io/cronjob-tutorial/basic-project.html
[homebrew_tool]:https://brew.sh/
[go_mod_wiki]: https://github.com/golang/go/wiki/Modules
[go_vendoring]: https://blog.gopheracademy.com/advent-2015/vendor-folder/
[doc_client_api]:/docs/golang/new/references/client/
[doc_client_api]:/docs/golang/references/client/
[manager_go_doc]: https://godoc.org/github.com/kubernetes-sigs/controller-runtime/pkg/manager#Manager
[controller-go-doc]: https://godoc.org/github.com/kubernetes-sigs/controller-runtime/pkg#hdr-Controller
[request-go-doc]: https://godoc.org/github.com/kubernetes-sigs/controller-runtime/pkg/reconcile#Request
Expand All @@ -488,8 +488,8 @@ Also see the [advanced topics][advanced_topics] doc for more use cases and under
[builder_godocs]: https://godoc.org/github.com/kubernetes-sigs/controller-runtime/pkg/builder#example-Builder
[legacy_quickstart_doc]:/docs/golang/legacy/quickstart/
[activate_modules]: https://github.com/golang/go/wiki/Modules#how-to-install-and-activate-module-support
[advanced_topics]: /docs/golang/new/advanced-topics/
[create_a_webhook]: /docs/golang/new/webhooks/
[advanced_topics]: /docs/golang/advanced-topics/
[create_a_webhook]: /docs/golang/webhooks/
[status_marker]: https://book.kubebuilder.io/reference/generating-crd.html#status
[status_subresource]: https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#status-subresource
[API-groups]:https://kubernetes.io/docs/concepts/overview/kubernetes-api/#api-groups
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -201,8 +201,8 @@ memcached-operator-controller-manager 1/1 1 1 10m
memcached-sample 5/5 5 5 3m
```

[quickstart_run_as_deployment]: /docs/golang/new/quickstart/#2-run-as-a-deployment-inside-the-cluster
[quickstart_create_a_cr]: /docs/golang/new/quickstart/#create-a-memcached-cr
[quickstart_run_as_deployment]: /docs/golang/quickstart/#2-run-as-a-deployment-inside-the-cluster
[quickstart_create_a_cr]: /docs/golang/quickstart/#create-a-memcached-cr

[kubebuilder_admission_controllers]: https://book.kubebuilder.io/reference/admission-webhook.html
[kubebuilder_cronjob_webhook]: https://book.kubebuilder.io/cronjob-tutorial/webhook-implementation.html
Expand Down
2 changes: 1 addition & 1 deletion website/layouts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ <h3 class="of-heading of-heading--lg">Go</h3>
<li>Use the SDK CLI to build and generate the operator deployment manifests</li>
</ol>

<a href="/docs/golang/new/quickstart/" class="of-button of-button--tertiary">
<a href="/docs/golang/quickstart/" class="of-button of-button--tertiary">
Develop with Go
<svg class="of-button__icon" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" width="22px"
height="22px" viewBox="0 0 22 22" style="enable-background:new 0 0 22 22;" xml:space="preserve">
Expand Down