Skip to content
This repository has been archived by the owner on May 6, 2022. It is now read-only.

Improve caching OSB clients #2577

Merged

Conversation

piotrmiskiewicz
Copy link
Contributor

@piotrmiskiewicz piotrmiskiewicz commented Mar 8, 2019

This PR is a

  • Feature Implementation
  • Bug Fix
  • Documentation

What this PR does / why we need it:
The idea of caching OSB clients was changed:

  1. New client instance is created when it is not present in the cache
  2. Secret with Auth data is alway fetched (from informer cache) - so there is no risk the auth data is outdated. If the auth data has beed changed - new OSB client will be created

Which issue(s) this PR fixes
Fixes #2576
Fixes #2563

Please leave this checklist in the PR comment so that maintainers can ensure a good PR.

Merge Checklist:

  • New feature
    • Tests
    • Documentation
  • SVCat CLI flag
  • Server Flag for config
    • Chart changes
    • removing a flag by marking deprecated and hiding to avoid
      breaking the chart release and existing clients who provide a
      flag that will get an error when they try to update

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 8, 2019
@k8s-ci-robot
Copy link
Contributor

Hi @piotrmiskiewicz. Thanks for your PR.

I'm waiting for a kubernetes-incubator or kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 8, 2019
@piotrmiskiewicz piotrmiskiewicz changed the title Osb client manager fix Improve caching OSB clients Mar 8, 2019
Copy link
Contributor

@jboyd01 jboyd01 left a comment

Choose a reason for hiding this comment

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

looks good, add an error check and I think you are good to go.

if !found {
return nil, fmt.Errorf("OSB client not found for the broker %s", broker.Name)
}
brokerClient, err = c.clusterServiceBrokerClient(broker)
Copy link
Contributor

Choose a reason for hiding this comment

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

check for non-nil err after this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

you are right, the check is missing, added

@piotrmiskiewicz piotrmiskiewicz force-pushed the osb-client-manager-fix branch 2 times, most recently from 7f0923d to cbae253 Compare March 8, 2019 13:55
@jboyd01
Copy link
Contributor

jboyd01 commented Mar 8, 2019

Thanks @piotrmiskiewicz!
/approve
/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 8, 2019
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jboyd01

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 Mar 8, 2019
@jboyd01 jboyd01 requested review from jberkhahn and removed request for jeremyrickard March 8, 2019 14:19
@jberkhahn
Copy link
Contributor

Do you think it would be possible add a new test to replace the one removed in controller_servicebroker_test.go? Something to test the new client fetching the auth info?

@piotrmiskiewicz
Copy link
Contributor Author

piotrmiskiewicz commented Mar 8, 2019

Hi, I'm planning rewrite integration tests as a part of switching to CRDs. The PR is not yet prepared, but I have a controller test which covers the scenario. I've just cherry-picked the commit to the branch with refreshing auth info and I've created a branch to show you how it will looks like. The test is passing, see: https://github.com/piotrmiskiewicz/service-catalog/blob/osb-test/test/controller/flow_test.go#L13

You can see there:

  1. create a secret with some username and password
  2. all calls to osb client makes the last auth saved (then it can be verified)
  3. there are asserts, which verifies the last auth used (method AssertOSBBasicAuth)

@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 8, 2019
@piotrmiskiewicz
Copy link
Contributor Author

I realized the test TestReconcileServiceBrokerUpdatesBrokerClient still can work, I've restored it.

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Mar 8, 2019
@jberkhahn
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Mar 11, 2019
@jberkhahn
Copy link
Contributor

Hmm, the git robot didn't assign the issue to me when i commented on Friday. Weird.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
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 Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provisioning error "no OSB client created" The controller does not refresh auth data from a secret
4 participants