diff --git a/cmd/operator-sdk/main.go b/cmd/operator-sdk/main.go index 6fa697c89a..76b4ee6a4e 100644 --- a/cmd/operator-sdk/main.go +++ b/cmd/operator-sdk/main.go @@ -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 { diff --git a/internal/util/projutil/project_util.go b/internal/util/projutil/project_util.go index 66897d69e9..418320e3ae 100644 --- a/internal/util/projutil/project_util.go +++ b/internal/util/projutil/project_util.go @@ -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 } diff --git a/proposals/leader-for-life.md b/proposals/leader-for-life.md index 1e6b7871c3..4ec7ef2cfb 100644 --- a/proposals/leader-for-life.md +++ b/proposals/leader-for-life.md @@ -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) diff --git a/website/content/en/build/_index.html b/website/content/en/build/_index.html index 5e3b198a65..c83869c3e2 100644 --- a/website/content/en/build/_index.html +++ b/website/content/en/build/_index.html @@ -56,7 +56,7 @@

READ THE USER GUIDES

-
  • +
  • Go Quickstart diff --git a/website/content/en/docs/_index.md b/website/content/en/docs/_index.md index 47c3c6272a..592ebd5f49 100644 --- a/website/content/en/docs/_index.md +++ b/website/content/en/docs/_index.md @@ -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 diff --git a/website/content/en/docs/contribution-guidelines/testing/travis-build.md b/website/content/en/docs/contribution-guidelines/testing/travis-build.md index ae4d7a7ca3..981e9853dd 100644 --- a/website/content/en/docs/contribution-guidelines/testing/travis-build.md +++ b/website/content/en/docs/contribution-guidelines/testing/travis-build.md @@ -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 diff --git a/website/content/en/docs/faq.md b/website/content/en/docs/faq.md index c5f7698223..48e959656f 100644 --- a/website/content/en/docs/faq.md +++ b/website/content/en/docs/faq.md @@ -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 diff --git a/website/content/en/docs/golang/new/advanced-topics.md b/website/content/en/docs/golang/advanced-topics.md similarity index 100% rename from website/content/en/docs/golang/new/advanced-topics.md rename to website/content/en/docs/golang/advanced-topics.md diff --git a/website/content/en/docs/golang/new/crds-scope.md b/website/content/en/docs/golang/crds-scope.md similarity index 98% rename from website/content/en/docs/golang/new/crds-scope.md rename to website/content/en/docs/golang/crds-scope.md index 964918ce30..2e0d59fa92 100644 --- a/website/content/en/docs/golang/new/crds-scope.md +++ b/website/content/en/docs/golang/crds-scope.md @@ -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 diff --git a/website/content/en/docs/golang/new/installation.md b/website/content/en/docs/golang/installation.md similarity index 100% rename from website/content/en/docs/golang/new/installation.md rename to website/content/en/docs/golang/installation.md diff --git a/website/content/en/docs/golang/legacy/_index.md b/website/content/en/docs/golang/legacy/_index.md index f0bdd690eb..7703f71e51 100644 --- a/website/content/en/docs/golang/legacy/_index.md +++ b/website/content/en/docs/golang/legacy/_index.md @@ -1,4 +1,4 @@ --- -title: Golang Based Operators - Legacy CLI -weight: 200 +title: Legacy CLI and Project Layout +weight: 300 --- diff --git a/website/content/en/docs/golang/legacy/quickstart.md b/website/content/en/docs/golang/legacy/quickstart.md index 7673d5f2f8..fc9b3a5076 100644 --- a/website/content/en/docs/golang/legacy/quickstart.md +++ b/website/content/en/docs/golang/legacy/quickstart.md @@ -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 \ No newline at end of file diff --git a/website/content/en/docs/golang/new/_index.md b/website/content/en/docs/golang/new/_index.md deleted file mode 100644 index eee29e9338..0000000000 --- a/website/content/en/docs/golang/new/_index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: Golang Based Operators - New CLI -weight: 20 ---- diff --git a/website/content/en/docs/golang/new/operator-scope.md b/website/content/en/docs/golang/operator-scope.md similarity index 99% rename from website/content/en/docs/golang/new/operator-scope.md rename to website/content/en/docs/golang/operator-scope.md index d2d090e001..62c098871b 100644 --- a/website/content/en/docs/golang/new/operator-scope.md +++ b/website/content/en/docs/golang/operator-scope.md @@ -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 \ No newline at end of file diff --git a/website/content/en/docs/golang/new/project_migration_guide.md b/website/content/en/docs/golang/project_migration_guide.md similarity index 98% rename from website/content/en/docs/golang/new/project_migration_guide.md rename to website/content/en/docs/golang/project_migration_guide.md index cde1c93a32..be8f7c9308 100644 --- a/website/content/en/docs/golang/new/project_migration_guide.md +++ b/website/content/en/docs/golang/project_migration_guide.md @@ -1,7 +1,7 @@ --- title: Migrating Legacy Projects linkTitle: Migrating Legacy Projects -weight: 300 +weight: 200 --- # Overview @@ -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 @@ -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/ diff --git a/website/content/en/docs/golang/new/quickstart.md b/website/content/en/docs/golang/quickstart.md similarity index 98% rename from website/content/en/docs/golang/new/quickstart.md rename to website/content/en/docs/golang/quickstart.md index 0f0ea10926..a958cd8fdc 100644 --- a/website/content/en/docs/golang/new/quickstart.md +++ b/website/content/en/docs/golang/quickstart.md @@ -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 @@ -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 diff --git a/website/content/en/docs/golang/new/references/_index.md b/website/content/en/docs/golang/references/_index.md similarity index 100% rename from website/content/en/docs/golang/new/references/_index.md rename to website/content/en/docs/golang/references/_index.md diff --git a/website/content/en/docs/golang/new/references/client.md b/website/content/en/docs/golang/references/client.md similarity index 100% rename from website/content/en/docs/golang/new/references/client.md rename to website/content/en/docs/golang/references/client.md diff --git a/website/content/en/docs/golang/new/references/event-filtering.md b/website/content/en/docs/golang/references/event-filtering.md similarity index 100% rename from website/content/en/docs/golang/new/references/event-filtering.md rename to website/content/en/docs/golang/references/event-filtering.md diff --git a/website/content/en/docs/golang/new/references/logging.md b/website/content/en/docs/golang/references/logging.md similarity index 100% rename from website/content/en/docs/golang/new/references/logging.md rename to website/content/en/docs/golang/references/logging.md diff --git a/website/content/en/docs/golang/new/references/markers.md b/website/content/en/docs/golang/references/markers.md similarity index 100% rename from website/content/en/docs/golang/new/references/markers.md rename to website/content/en/docs/golang/references/markers.md diff --git a/website/content/en/docs/golang/new/webhooks.md b/website/content/en/docs/golang/webhooks.md similarity index 98% rename from website/content/en/docs/golang/new/webhooks.md rename to website/content/en/docs/golang/webhooks.md index 8e14c17299..387b6727d2 100644 --- a/website/content/en/docs/golang/new/webhooks.md +++ b/website/content/en/docs/golang/webhooks.md @@ -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 diff --git a/website/layouts/index.html b/website/layouts/index.html index 0a2387ae3c..64b0e7a7d7 100644 --- a/website/layouts/index.html +++ b/website/layouts/index.html @@ -58,7 +58,7 @@

    Go

  • Use the SDK CLI to build and generate the operator deployment manifests
    • - + Develop with Go