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

Mystery clusterrole reference in docs/getting-started #1587

Open
waltforme opened this issue May 5, 2023 · 1 comment
Open

Mystery clusterrole reference in docs/getting-started #1587

waltforme opened this issue May 5, 2023 · 1 comment
Assignees
Labels
kind/bug Categorizes issue or PR as related to a bug.

Comments

@waltforme
Copy link

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
  1. 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

  • Kubernetes version:

    Output of kubectl version:

Client Version: version.Info{Major:"1", Minor:"24", GitVersion:"v1.24.0", GitCommit:"4ce5a8954017644c5420bae81d72b09b735c21f0", GitTreeState:"clean", BuildDate:"2022-05-03T13:46:05Z", GoVersion:"go1.18.1", Compiler:"gc", Platform:"darwin/amd64"}
Kustomize Version: v4.5.4
Server Version: version.Info{Major:"1", Minor:"25", GitVersion:"v1.25.0", GitCommit:"a866cbe2e5bbaa01cfd5e969aa3e033f3282a8a2", GitTreeState:"clean", BuildDate:"2022-08-23T17:38:15Z", GoVersion:"go1.19", Compiler:"gc", Platform:"linux/amd64"}
  • Tekton Pipeline version:

    Client version: 0.26.0
    Pipeline version: v0.40.0
    Triggers version: v0.21.0

  • The tutorial documented by docs/getting-started/README.md works anyway, even if the clusterrole tekton-triggers-example-clusterrole doesn't exist.

  • docs/getting-started/README.md instructs readers to delete the getting-started namespace for cleaning up. But the cluster scoped RBAC objects, e.g. clusterrolebindings, won't get cleaned.

  • I can see the the Tekton website is not using docs/getting-started, but I guess there is not harm to fix it :)

@waltforme waltforme added the kind/bug Categorizes issue or PR as related to a bug. label May 5, 2023
@AlanGreene
Copy link
Member

@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.

@dibyom dibyom added this to the Triggers v0.25 milestone Jun 14, 2023
@dibyom dibyom self-assigned this Jun 14, 2023
@dibyom dibyom modified the milestones: Triggers v0.25, Triggers v0.26 Sep 6, 2023
@khrm khrm modified the milestones: Triggers v0.27, Triggers v0.28 May 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug.
Projects
None yet
Development

No branches or pull requests

5 participants