Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: quickstart for Go projects #3551

Merged
merged 6 commits into from
Aug 5, 2020
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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Advanced Topics
linkTitle: Advanced Topics
weight: 50
weight: 70
---

### Manage CR status conditions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: CRD Scope
linkTitle: CRD Scope
weight: 30
weight: 60
---

## Overview
Expand Down Expand Up @@ -97,5 +97,5 @@ spec:
```

[RBAC]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/
[manager_user_guide]:/docs/building-operators/golang/quickstart/#manager
[manager_user_guide]:/docs/building-operators/golang/tutorial/#manager
[manager_options]: https://godoc.org/github.com/kubernetes-sigs/controller-runtime/pkg/manager#Options
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,12 @@ Follow the steps in the [installation guide][install-guide] to learn how to inst
- [mercurial][mercurial_tool] version 3.9+
- [docker][docker_tool] version 17.03+.
- [kubectl][kubectl_tool] version v1.11.3+.
- Access to a Kubernetes v1.11.3+ cluster.

**Note**: This guide uses [minikube][minikube-tool] version v0.25.0+ as the
local Kubernetes cluster and [quay.io][quay-link] for the public registry.
- Access to a Kubernetes v1.11.3+ cluster (v1.16.0+ if using `apiextensions.k8s.io/v1` CRDs).

[git_tool]:https://git-scm.com/downloads
[go_tool]:https://golang.org/dl/
[docker_tool]:https://docs.docker.com/install/
[mercurial_tool]:https://www.mercurial-scm.org/downloads
[kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
[install-guide]: /docs/installation/install-operator-sdk
[minikube-tool]:https://github.com/kubernetes/minikube#installation
[quay-link]:https://quay.io
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Operators Scope
linkTitle: Operator Scope
weight: 20
weight: 50
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Run [`make manifests`][generate_crd] to generate CRD manifests. They would be ge

Projects are scaffolded with unit tests that utilize the [envtest](https://godoc.org/sigs.k8s.io/controller-runtime/pkg/envtest)
library, which requires certain Kubernetes server binaries be present locally.
Installation instructions can be found [here][env-test-setup].
Installation instructions can be found [here][envtest-setup].

## Operator Manifests

Expand Down Expand Up @@ -159,10 +159,10 @@ func (r *MemcachedReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
**Note**:
To update `config/rbac/role.yaml` after changing the markers, run `make manifests`.

The project can now be built, and the operator can be deployed on-cluster. For further steps regarding the deployment of the operator, creation of custom resources and cleaning up of resources, refer to the [quickstart guide][kb_quickstart].
The project can now be built, and the operator can be deployed on-cluster. For further steps regarding the deployment of the operator, creation of custom resources and cleaning up of resources, refer to the [tutorial][tutorial].


[memcached-operator]:/docs/building-operators/golang/quickstart/
[quickstart-legacy]:https://v0-19-x.sdk.operatorframework.io/docs/golang/quickstart/
[git_tool]: https://git-scm.com/downloads
[go_tool]: https://golang.org/dl/
[docker_tool]:https://docs.docker.com/install/
Expand All @@ -177,6 +177,6 @@ The project can now be built, and the operator can be deployed on-cluster. For f
[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/memcached-operator/memcached_controller.go.tmpl
[kb_quickstart]: /docs/building-operators/golang/quickstart/
[tutorial]: /docs/building-operators/golang/tutorial/
[install_guide]: /docs/installation/install-operator-sdk/
[env-test-setup]: /docs/building-operators/golang/references/env-test-setup
[envtest-setup]: /docs/building-operators/golang/references/envtest-setup
Loading