Skip to content

support fieldSelector for Informer #965

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

Merged
merged 3 commits into from
Jan 20, 2023

Conversation

andekande
Copy link
Contributor

@andekande andekande commented Jan 20, 2023

In order to watch a resource list that is protected by a role on the resource name, we must be able to specify that name as fieldselector both in the request to watch (client-node.makeInformer()) and list (coreV1Api.listNamespaced[Resource]).

This is documented here: https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources

If you restrict list or watch by resourceName, clients must include a metadata.name field selector in their list or watch request that matches the specified resourceName in order to be authorized.

An example is outlined explained in broader detail in the accompanying PR: kubernetes/website#29468

This is code to verify the desired state:

const k8s = require('@kubernetes/client-node');
const fs = require('fs')
const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const k8sCoreApi = kc.makeApiClient(k8s.CoreV1Api);
const listFn = () => this.k8sCoreApi.listNamespacedSecret("myNamespace", undefined, undefined, undefined, "metadata.name=mySecret");
const informer = k8s.makeInformer(kc, "/api/v1/namespaces/myNamespace/secrets", listFn, undefined, "metadata.name=mySecret");

informer.on(k8s.ERROR, (err) => {
    console.error(err);
    // winding up with a 403 if fieldSelector is not specified for the makeInformer request
    // the list request is okay though
});

informer.start();

Currently this code produces:

Error: Forbidden
    at Request.<anonymous> (/app/beb-luigi-core/node_modules/@kubernetes/client-node/dist/watch.js:23:31)
    at Request.emit (events.js:314:20)
    at Request.onRequestResponse (/app/beb-luigi-core/node_modules/request/request.js:1059:10)
    at ClientRequest.emit (events.js:314:20)
    at HTTPParser.parserOnIncomingClient [as onIncoming] (_http_client.js:601:27)
    at HTTPParser.parserOnHeadersComplete (_http_common.js:122:17)
    at TLSSocket.socketOnData (_http_client.js:474:22)
    at TLSSocket.emit (events.js:314:20)
    at addChunk (_stream_readable.js:297:12)
    at readableAddChunk (_stream_readable.js:272:9) {
  statusCode: 403
}

When this role is in use:

apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
  name: secret-role
  namespace: myNamespace
rules:
  - apiGroups: [""]
    resources: ["secrets"]
    resourceNames: [ "mySecret" ]
    verbs: ["watch", "get", "list"]
```

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jan 20, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jan 20, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @andekande!

It looks like this is your first PR to kubernetes-client/javascript 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-client/javascript has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot requested a review from drubin January 20, 2023 20:00
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jan 20, 2023
@brendandburns
Copy link
Contributor

/lgtm
/approve

Thanks for the PR (and special thanks for writing unit tests!)

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 20, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: andekande, brendandburns

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 20, 2023
@k8s-ci-robot k8s-ci-robot merged commit f293107 into kubernetes-client:master Jan 20, 2023
@andekande
Copy link
Contributor Author

Thanks for the PR (and special thanks for writing unit tests!)

Thanks for the excellent first-contributor experience!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants