tektoncd / triggers

Event triggering with Tekton!
Apache License 2.0
557 stars 420 forks source link

Mystery clusterrole reference in docs/getting-started #1587

Open waltforme opened 1 year ago

waltforme commented 1 year ago

Expected Behavior

The roleRef of the tekton-triggers-getting-started-clusterbinding clusterrolebinding in docs/getting-started/rbac/clusterrolebinding.yaml refers to some real clusterrole.

Actual Behavior

The roleRef refers to a clusterrole tekton-triggers-example-clusterrole which doesn't exist.

Steps to Reproduce the Problem

  1. The referred clusterrole tekton-triggers-example-clusterrole only appears once in this repository.
    $ grep tekton-triggers-example-clusterrole -rn .
    ./docs/getting-started/rbac/clusterrolebinding.yaml:12:  name: tekton-triggers-example-clusterrole
  2. The referred clusterrole tekton-triggers-example-clusterrole doesn't exist in a cluster with Tekton Pipelines and Tekton Triggers installed.
    $ kubectl get clusterrole | grep tekton
    tekton-aggregate-edit                                                  2022-09-20T07:12:33Z
    tekton-aggregate-view                                                  2022-09-20T07:12:33Z
    tekton-pipelines-controller-cluster-access                             2022-09-20T07:12:31Z
    tekton-pipelines-controller-tenant-access                              2022-09-20T07:12:31Z
    tekton-pipelines-webhook-cluster-access                                2022-09-20T07:12:31Z
    tekton-triggers-admin                                                  2022-09-24T07:25:22Z
    tekton-triggers-aggregate-edit                                         2022-09-24T07:25:26Z
    tekton-triggers-aggregate-view                                         2022-09-24T07:25:26Z
    tekton-triggers-core-interceptors                                      2022-09-24T07:25:22Z
    tekton-triggers-core-interceptors-secrets                              2022-09-24T07:25:23Z
    tekton-triggers-eventlistener-clusterroles                             2022-09-24T07:25:23Z
    tekton-triggers-eventlistener-roles                                    2022-09-24T07:25:23Z

Additional Info

AlanGreene commented 1 year ago

@tektoncd/triggers-maintainers Should the getting-started doc in the Triggers repo be removed? It looks like the content of the readme hasn't been updated in 2 years.

The Triggers getting started guide displayed on the website comes from the website repo instead and was added at the end of 2022: https://github.com/tektoncd/website/blob/main/content/en/docs/Getting-started/triggers.md

It could be confusing having 2 different versions, as it's not immediately clear to users which is correct / current.