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

Consider whether BrokerSpec.AuthSecret should change #864

Closed
pmorie opened this issue May 16, 2017 · 0 comments
Closed

Consider whether BrokerSpec.AuthSecret should change #864

pmorie opened this issue May 16, 2017 · 0 comments
Labels
Milestone

Comments

@pmorie
Copy link
Contributor

pmorie commented May 16, 2017

Currently the OSB API only supports basic auth. Adding an OAuth flow is being discussed, and so we should assume that long-term, there will be multiple forms of auth. Currently, we have a single field called AuthSecret in the BrokerSpec type, so the type of auth being used does not surface at all in the API. I think we should consider using a union type to make explicit in the broker spec what form of auth is requested. Example:

type BrokerSpec struct {
  // other fields omitted

  AuthInfo *AuthInfo
}

type AuthInfo struct {
  BasicAuthSecret *v1.ObjectReference

  // in the future:
  OAuthSecret *v1.ObjectReference
}

...this would allow us to add new auth methods in a backward-compatible way.

Thoughts?

@pmorie pmorie added the api label May 16, 2017
@pmorie pmorie added this to the 0.1.0 milestone May 16, 2017
arschles added a commit to arschles/kubernetes-service-catalog that referenced this issue May 18, 2017
This change will enable operators to chose different auth schemes for
brokers, as the OSB API spec begins to support more in the future.

Fixes kubernetes-retired#864
arschles added a commit to arschles/kubernetes-service-catalog that referenced this issue May 22, 2017
This change will enable operators to chose different auth schemes for
brokers, as the OSB API spec begins to support more in the future.

Fixes kubernetes-retired#864
arschles added a commit to arschles/kubernetes-service-catalog that referenced this issue Jun 5, 2017
This change will enable operators to chose different auth schemes for
brokers, as the OSB API spec begins to support more in the future.

Fixes kubernetes-retired#864
arschles added a commit to arschles/kubernetes-service-catalog that referenced this issue Jun 7, 2017
This change will enable operators to chose different auth schemes for
brokers, as the OSB API spec begins to support more in the future.

Fixes kubernetes-retired#864
pmorie pushed a commit that referenced this issue Jun 7, 2017
* Converting the AuthSecret field to a union AuthInfo type

This change will enable operators to chose different auth schemes for
brokers, as the OSB API spec begins to support more in the future.

Fixes #864

* fixing test compile issues

* adding grammar to godoc

* adding grammar to open api description
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants