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.

Sign up for GitHub

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

Jump to bottom

docs: fix broken links (CI) #3514

Merged
merged 3 commits into from
Jul 24, 2020
Merged

docs: fix broken links (CI) #3514

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5417faa
docs: remove leader sdk implementation that is no longer supported - …
camilamacedo86 Jul 24, 2020
532de02
doc: fix link for leader election
camilamacedo86 Jul 24, 2020
cc28f73
doc: fix link for leader election
camilamacedo86 Jul 24, 2020
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
16 changes: 15 additions & 1 deletion website/content/en/docs/building-operators/golang/advanced-topics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,14 @@ type MyAppStatus struct {
}
```

<!-- todo(camilamacedo)
the following link was comment for do no broke the CI
this impl probably will came from operator-lib
however, we also need to check if we would not like to just let them use
https://github.com/kubernetes/kubernetes/pull/92717/files
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pkg/status was also moved to operator-lib. Let's just update that link as well.

And I don't think this is the appropriate place for a comment about the choice of implementations to use.

I think a better choice would be to open an issue in operator-lib asking whether it makes sense to deprecate status and point users to k8s.io/apimachinery's implementation.


Then, in your controller, you can use [`Conditions`][godoc-conditions] methods to make it easier to set and remove conditions or check their current values.
-->

### Adding 3rd Party Resources To Your Operator

Expand Down Expand Up @@ -287,14 +294,21 @@ func main() {
When the operator is not running in a cluster, the Manager will return an error on starting since it can't detect the operator's namespace in order to create the configmap for leader election. You can override this namespace by setting the Manager's `LeaderElectionNamespace` option.

[typical-status-properties]: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties

<!-- todo(camilamacedo)
the following link was comment for do no broke the CI
this impl probably will came from operator-lib
however, we also need to check if we would not like to just let them use
https://github.com/kubernetes/kubernetes/pull/92717/files
[godoc-conditions]: https://godoc.org/github.com/operator-framework/operator-sdk/pkg/status#Conditions
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this one is falling now. I am not sure if we will still providing or not the helper in via operator-lib so just comment and raised : #3515

-->
[scheme_package]:https://github.com/kubernetes/client-go/blob/master/kubernetes/scheme/register.go
[deployments_register]: https://github.com/kubernetes/api/blob/master/apps/v1/register.go#L41
[runtime_package]: https://godoc.org/k8s.io/apimachinery/pkg/runtime
[scheme_builder]: https://godoc.org/sigs.k8s.io/controller-runtime/pkg/scheme#Builder
[metrics_doc]: https://book.kubebuilder.io/reference/metrics.html
[lease_split_brain]: https://github.com/kubernetes/client-go/blob/30b06a83d67458700a5378239df6b96948cb9160/tools/leaderelection/leaderelection.go#L21-L24
[leader_for_life]: https://godoc.org/github.com/operator-framework/operator-sdk/pkg/leader
[leader_for_life]: https://godoc.org/github.com/operator-framework/operator-lib/leader
[leader_with_lease]: https://godoc.org/github.com/kubernetes-sigs/controller-runtime/pkg/leaderelection
[pod_eviction_timeout]: https://kubernetes.io/docs/reference/command-line-tools-reference/kube-controller-manager/#options
[manager_options]: https://godoc.org/github.com/kubernetes-sigs/controller-runtime/pkg/manager#Options