Documentation
¶
Overview ¶
+kubebuilder:object:generate=true
Index ¶
- type Auth
- func (in *Auth) DeepCopy() *Auth
- func (in *Auth) DeepCopyInto(out *Auth)
- func (in *Auth) GetBearerToken() string
- func (in *Auth) GetCredentials() core.BasicAuth
- func (in *Auth) GetSecretRef() core.ObjectRef
- func (in *Auth) HasCredentials() bool
- func (in *Auth) SetCredentials(username string, password string)
- func (in *Auth) SetSecretRef(ref core.ObjectRef)
- func (in *Auth) SetToken(token string)
- type BasicAuth
- type Cloud
- type Context
- func (c *Context) ConfigureCloud(url string, orgID string, envID string)
- func (in *Context) DeepCopy() *Context
- func (in *Context) DeepCopyInto(out *Context)
- func (c *Context) GetAuth() core.Auth
- func (c *Context) GetCloud() core.Cloud
- func (c *Context) GetEnvID() string
- func (c *Context) GetOrgID() string
- func (c *Context) GetPath() *string
- func (c *Context) GetSecretRef() core.ObjectRef
- func (c *Context) GetURL() string
- func (c *Context) HasAuthentication() bool
- func (c *Context) HasCloud() bool
- func (c *Context) HasSecretRef() bool
- func (c *Context) SecretRef() *refs.NamespacedName
- func (c *Context) SetCredentials(username, password string)
- func (c *Context) SetToken(token string)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Auth ¶
type Auth struct {
// The bearer token used to authenticate against the API Management instance
// (must be generated from an admin account)
// +kubebuilder:validation:Optional
BearerToken string `json:"bearerToken,omitempty"`
// The Basic credentials used to authenticate against the API Management instance.
Credentials *BasicAuth `json:"credentials,omitempty"`
// A secret reference holding either a "bearerToken" key for bearer token authentication
// or "username" and "password" keys for basic authentication
SecretRef *refs.NamespacedName `json:"secretRef,omitempty"`
}
func (*Auth) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Auth.
func (*Auth) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Auth) GetBearerToken ¶
GetBearerToken implements custom.Auth.
func (*Auth) GetCredentials ¶
GetCredentials implements custom.Auth.
func (*Auth) GetSecretRef ¶
GetSecretRef implements custom.Auth.
func (*Auth) HasCredentials ¶
HasCredentials implements custom.Auth.
func (*Auth) SetCredentials ¶
SetCredentials implements custom.Auth.
func (*Auth) SetSecretRef ¶
SetSecretRef implements custom.Auth.
type BasicAuth ¶
type BasicAuth struct {
// +kubebuilder:validation:Required
Username string `json:"username,omitempty"`
// +kubebuilder:validation:Required
Password string `json:"password,omitempty"`
}
func (*BasicAuth) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BasicAuth.
func (*BasicAuth) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BasicAuth) GetPassword ¶
GetPassword implements custom.BasicAuth.
func (*BasicAuth) GetUsername ¶
GetUsername implements custom.BasicAuth.
type Cloud ¶
type Cloud struct {
// Token plain text Gravitee cloud token (JWT)
// +kubebuilder:validation:Optional
Token string `json:"token,omitempty"`
// SecretRef secret reference holding the Gravitee cloud token in the "cloudToken" key
// +kubebuilder:validation:Optional
SecretRef *refs.NamespacedName `json:"secretRef,omitempty"`
}
func (*Cloud) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Cloud.
func (*Cloud) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Cloud) GetSecretRef ¶
func (*Cloud) HasSecretRef ¶
type Context ¶
type Context struct {
// The URL of a management API instance.
// This is optional when this context targets Gravitee Cloud otherwise it is required.
// +kubebuilder:validation:Optional
BaseUrl string `json:"baseUrl,omitempty"`
// Allows to override the context path that will be appended to the baseURL.
// This can be used when reverse proxying APIM with URL rewrite
// +kubebuilder:validation:Optional
Path *string `json:"path,omitempty"`
// An existing organization id targeted by the context on the management API instance.
// This is optional when this context targets Gravitee Cloud otherwise it is required.
// +kubebuilder:validation:Optional
OrgID string `json:"organizationId,omitempty"`
// An existing environment id targeted by the context within the organization.
// This is optional when this context targets Gravitee Cloud
// and your cloud token contains only one environment ID, otherwise it is required.
// +kubebuilder:validation:Optional
EnvID string `json:"environmentId,omitempty"`
// Auth defines the authentication method used to connect to the API Management.
// Can be either basic authentication credentials, a bearer token
// or a reference to a kubernetes secret holding one of these two configurations.
// This is optional when this context targets Gravitee Cloud.
Auth *Auth `json:"auth,omitempty"`
// Cloud when set (token or secretRef) this context will target Gravitee Cloud.
// BaseUrl will be defaulted from token data if not set,
// Auth is defaulted to use the token (bearerToken),
// OrgID is extracted from the token,
// EnvID is defaulted when the token contains exactly one environment.
Cloud *Cloud `json:"cloud,omitempty"`
}
func (*Context) ConfigureCloud ¶
func (*Context) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Context.
func (*Context) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Context) GetSecretRef ¶
GetSecretRef implements custom.Context.
func (*Context) HasAuthentication ¶
func (*Context) HasSecretRef ¶
func (*Context) SecretRef ¶
func (c *Context) SecretRef() *refs.NamespacedName
Source Files