Documentation
¶
Overview ¶
Package v1beta1 contains API Schema definitions for the microcumul.us v1beta1 API group +kubebuilder:object:generate=true +groupName=microcumul.us
Index ¶
- Variables
- type ClientAuth
- type ClusterOAuth2ClientProvider
- type ClusterOAuth2ClientProviderList
- type ClusterOAuth2ClientProviderSpec
- type ClusterOAuth2ClientProviderStatus
- type KeycloakProvider
- type OAuth2Client
- type OAuth2ClientList
- type OAuth2ClientProvider
- type OAuth2ClientProviderList
- type OAuth2ClientProviderSpec
- type OAuth2ClientProviderStatus
- type OAuth2ClientSpec
- type OAuth2ClientStatus
- type OAuth2Proxy
- type OAuth2ProxyList
- type OAuth2ProxySpec
- type OAuth2ProxyStatus
- type PasswordRef
- type Redis
- type SessionStore
- type UserAuth
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "microcumul.us", Version: "v1beta1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type ClientAuth ¶
type ClientAuth struct { ClientID string `json:"clientID"` ClientSecret *corev1.SecretKeySelector `json:"clientSecret"` }
ClientAuth allows the use of a keycloak client that has a ServiceAccount enabled with an admin role. See https://github.com/keycloak/keycloak-documentation/blob/b572fcff07950ac8c05c0d2f9e395234aea63cdd/server_admin/topics/clients/oidc/service-accounts.adoc
func (*ClientAuth) DeepCopy ¶
func (in *ClientAuth) DeepCopy() *ClientAuth
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClientAuth.
func (*ClientAuth) DeepCopyInto ¶
func (in *ClientAuth) DeepCopyInto(out *ClientAuth)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterOAuth2ClientProvider ¶
type ClusterOAuth2ClientProvider struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec ClusterOAuth2ClientProviderSpec `json:"spec,omitempty"` Status ClusterOAuth2ClientProviderStatus `json:"status,omitempty"` }
ClusterOAuth2ClientProvider is the Schema for the clusteroauth2clientproviders API
func (*ClusterOAuth2ClientProvider) DeepCopy ¶
func (in *ClusterOAuth2ClientProvider) DeepCopy() *ClusterOAuth2ClientProvider
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterOAuth2ClientProvider.
func (*ClusterOAuth2ClientProvider) DeepCopyInto ¶
func (in *ClusterOAuth2ClientProvider) DeepCopyInto(out *ClusterOAuth2ClientProvider)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterOAuth2ClientProvider) DeepCopyObject ¶
func (in *ClusterOAuth2ClientProvider) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterOAuth2ClientProviderList ¶
type ClusterOAuth2ClientProviderList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []ClusterOAuth2ClientProvider `json:"items"` }
ClusterOAuth2ClientProviderList contains a list of ClusterOAuth2ClientProvider
func (*ClusterOAuth2ClientProviderList) DeepCopy ¶
func (in *ClusterOAuth2ClientProviderList) DeepCopy() *ClusterOAuth2ClientProviderList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterOAuth2ClientProviderList.
func (*ClusterOAuth2ClientProviderList) DeepCopyInto ¶
func (in *ClusterOAuth2ClientProviderList) DeepCopyInto(out *ClusterOAuth2ClientProviderList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterOAuth2ClientProviderList) DeepCopyObject ¶
func (in *ClusterOAuth2ClientProviderList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterOAuth2ClientProviderSpec ¶
type ClusterOAuth2ClientProviderSpec struct {
Keycloak *KeycloakProvider `json:"keycloak"`
}
ClusterOAuth2ClientProviderSpec defines the desired state of ClusterOAuth2ClientProvider
func (*ClusterOAuth2ClientProviderSpec) DeepCopy ¶
func (in *ClusterOAuth2ClientProviderSpec) DeepCopy() *ClusterOAuth2ClientProviderSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterOAuth2ClientProviderSpec.
func (*ClusterOAuth2ClientProviderSpec) DeepCopyInto ¶
func (in *ClusterOAuth2ClientProviderSpec) DeepCopyInto(out *ClusterOAuth2ClientProviderSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterOAuth2ClientProviderStatus ¶
type ClusterOAuth2ClientProviderStatus struct { // INSERT ADDITIONAL STATUS FIELD - define observed state of cluster // Important: Run "make" to regenerate code after modifying this file Reason string `json:"state,omitempty"` Ready bool `json:"ready"` }
ClusterOAuth2ClientProviderStatus defines the observed state of ClusterOAuth2ClientProvider
func (*ClusterOAuth2ClientProviderStatus) DeepCopy ¶
func (in *ClusterOAuth2ClientProviderStatus) DeepCopy() *ClusterOAuth2ClientProviderStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterOAuth2ClientProviderStatus.
func (*ClusterOAuth2ClientProviderStatus) DeepCopyInto ¶
func (in *ClusterOAuth2ClientProviderStatus) DeepCopyInto(out *ClusterOAuth2ClientProviderStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakProvider ¶
type KeycloakProvider struct { // BaseURL is the externally-accessible base URL for the keycloak server BaseURL string `json:"baseURL"` // Realm is the keycloak Realm for which we have credentials and will provision clients. Realm string `json:"realm"` // UserAuth allows the provider code to authenticate with a keycloak user/password UserAuth *UserAuth `json:"userAuth,omitempty"` // ClientAuth allows the provider code to authenticate with a keycloak client // credential grant ClientAuth *ClientAuth `json:"clientAuth,omitempty"` // GroupClaimName configures the claim name the keycloak provider will set up as a client mapper. GroupClaimName string `json:"groupClaimName,omitempty"` }
KeycloakProvider holds the necessary data to create OAuth2 clients
func (*KeycloakProvider) DeepCopy ¶
func (in *KeycloakProvider) DeepCopy() *KeycloakProvider
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakProvider.
func (*KeycloakProvider) DeepCopyInto ¶
func (in *KeycloakProvider) DeepCopyInto(out *KeycloakProvider)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type OAuth2Client ¶
type OAuth2Client struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec OAuth2ClientSpec `json:"spec,omitempty"` Status OAuth2ClientStatus `json:"status,omitempty"` }
OAuth2Client is the Schema for the oauth2clients API
func (*OAuth2Client) DeepCopy ¶
func (in *OAuth2Client) DeepCopy() *OAuth2Client
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2Client.
func (*OAuth2Client) DeepCopyInto ¶
func (in *OAuth2Client) DeepCopyInto(out *OAuth2Client)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*OAuth2Client) DeepCopyObject ¶
func (in *OAuth2Client) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type OAuth2ClientList ¶
type OAuth2ClientList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []OAuth2Client `json:"items"` }
OAuth2ClientList contains a list of OAuth2Client
func (*OAuth2ClientList) DeepCopy ¶
func (in *OAuth2ClientList) DeepCopy() *OAuth2ClientList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2ClientList.
func (*OAuth2ClientList) DeepCopyInto ¶
func (in *OAuth2ClientList) DeepCopyInto(out *OAuth2ClientList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*OAuth2ClientList) DeepCopyObject ¶
func (in *OAuth2ClientList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type OAuth2ClientProvider ¶
type OAuth2ClientProvider struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec OAuth2ClientProviderSpec `json:"spec,omitempty"` Status OAuth2ClientProviderStatus `json:"status,omitempty"` }
OAuth2ClientProvider is the Schema for the oauth2clientproviders API
func (*OAuth2ClientProvider) DeepCopy ¶
func (in *OAuth2ClientProvider) DeepCopy() *OAuth2ClientProvider
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2ClientProvider.
func (*OAuth2ClientProvider) DeepCopyInto ¶
func (in *OAuth2ClientProvider) DeepCopyInto(out *OAuth2ClientProvider)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*OAuth2ClientProvider) DeepCopyObject ¶
func (in *OAuth2ClientProvider) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type OAuth2ClientProviderList ¶
type OAuth2ClientProviderList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []OAuth2ClientProvider `json:"items"` }
OAuth2ClientProviderList contains a list of OAuth2ClientProvider
func (*OAuth2ClientProviderList) DeepCopy ¶
func (in *OAuth2ClientProviderList) DeepCopy() *OAuth2ClientProviderList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2ClientProviderList.
func (*OAuth2ClientProviderList) DeepCopyInto ¶
func (in *OAuth2ClientProviderList) DeepCopyInto(out *OAuth2ClientProviderList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*OAuth2ClientProviderList) DeepCopyObject ¶
func (in *OAuth2ClientProviderList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type OAuth2ClientProviderSpec ¶
type OAuth2ClientProviderSpec struct { // Keycloak providers can provision oauth2 (oidc) clients from keycloak instances Keycloak *KeycloakProvider `json:"keycloak"` }
OAuth2ClientProviderSpec defines the desired state of OAuth2ClientProvider
func (*OAuth2ClientProviderSpec) DeepCopy ¶
func (in *OAuth2ClientProviderSpec) DeepCopy() *OAuth2ClientProviderSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2ClientProviderSpec.
func (*OAuth2ClientProviderSpec) DeepCopyInto ¶
func (in *OAuth2ClientProviderSpec) DeepCopyInto(out *OAuth2ClientProviderSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type OAuth2ClientProviderStatus ¶
type OAuth2ClientProviderStatus struct { // INSERT ADDITIONAL STATUS FIELD - define observed state of cluster // Important: Run "make" to regenerate code after modifying this file Reason string `json:"state,omitempty"` Ready bool `json:"ready"` }
OAuth2ClientProviderStatus defines the observed state of OAuth2ClientProvider
func (*OAuth2ClientProviderStatus) DeepCopy ¶
func (in *OAuth2ClientProviderStatus) DeepCopy() *OAuth2ClientProviderStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2ClientProviderStatus.
func (*OAuth2ClientProviderStatus) DeepCopyInto ¶
func (in *OAuth2ClientProviderStatus) DeepCopyInto(out *OAuth2ClientProviderStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type OAuth2ClientSpec ¶
type OAuth2ClientSpec struct { // Provider references the Oauth2ClientProvider or // ClusterOauth2ClientProvider that should provision this client. Provider string `json:"provider,omitempty"` ClusterProvider string `json:"clusterProvider,omitempty"` // ClientID is the optional clientid that the client should have. ClientID string `json:"clientID,omitempty"` // ClientName is the name of the client in keycloak. ClientName string `json:"clientName"` // SecretName is the desired secret that should hold the provisioned client's metadata SecretName string `json:"secretName"` SecretTemplate map[string]string `json:"secretTemplate,omitempty"` // Redirects is the list of valid redirects for this Client Redirects []string `json:"redirects"` }
OAuth2ClientSpec defines the desired state of OAuth2Client
func (*OAuth2ClientSpec) DeepCopy ¶
func (in *OAuth2ClientSpec) DeepCopy() *OAuth2ClientSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2ClientSpec.
func (*OAuth2ClientSpec) DeepCopyInto ¶
func (in *OAuth2ClientSpec) DeepCopyInto(out *OAuth2ClientSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type OAuth2ClientStatus ¶
type OAuth2ClientStatus struct { // INSERT ADDITIONAL STATUS FIELD - define observed state of cluster // Important: Run "make" to regenerate code after modifying this file Reason string `json:"state,omitempty"` Ready bool `json:"ready"` }
OAuth2ClientStatus defines the observed state of OAuth2Client
func (*OAuth2ClientStatus) DeepCopy ¶
func (in *OAuth2ClientStatus) DeepCopy() *OAuth2ClientStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2ClientStatus.
func (*OAuth2ClientStatus) DeepCopyInto ¶
func (in *OAuth2ClientStatus) DeepCopyInto(out *OAuth2ClientStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type OAuth2Proxy ¶
type OAuth2Proxy struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec OAuth2ProxySpec `json:"spec,omitempty"` Status OAuth2ProxyStatus `json:"status,omitempty"` }
OAuth2Proxy is the Schema for the oauth2proxies API
func (*OAuth2Proxy) DeepCopy ¶
func (in *OAuth2Proxy) DeepCopy() *OAuth2Proxy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2Proxy.
func (*OAuth2Proxy) DeepCopyInto ¶
func (in *OAuth2Proxy) DeepCopyInto(out *OAuth2Proxy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*OAuth2Proxy) DeepCopyObject ¶
func (in *OAuth2Proxy) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type OAuth2ProxyList ¶
type OAuth2ProxyList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []OAuth2Proxy `json:"items"` }
OAuth2ProxyList contains a list of OAuth2Proxy
func (*OAuth2ProxyList) DeepCopy ¶
func (in *OAuth2ProxyList) DeepCopy() *OAuth2ProxyList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2ProxyList.
func (*OAuth2ProxyList) DeepCopyInto ¶
func (in *OAuth2ProxyList) DeepCopyInto(out *OAuth2ProxyList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*OAuth2ProxyList) DeepCopyObject ¶
func (in *OAuth2ProxyList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type OAuth2ProxySpec ¶
type OAuth2ProxySpec struct { ClusterClientProvider string `json:"clusterClientProvider,omitempty"` ClientProvider string `json:"clientProvider,omitempty"` ClientType string `json:"clientType,omitempty"` SessionStore SessionStore `json:"sessionStore"` // IngressSelector instructs the controller to replace all ingresses that // match a specified selector. IngressSelector *metav1.LabelSelector `json:"ingressSelector,omitempty"` // Ingress instructs the controller to replace an ingress with a protected // proxied version. Ingress *v1.ObjectReference `json:"ingress"` // ServiceSelector instructs the controller to create proxies for all // services that match a given selector ServiceSelector *metav1.LabelSelector `json:"serviceSelector,omitempty"` // Service instructs the controller to target a specific single service. Service *v1.ObjectReference `json:"service,omitempty"` AllowedGroups []string `json:"allowedGroups,omitempty"` // All ProxyOpts that can be passed as environment variables can be specified // here. See // https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/overview // (or the latest equivalent of // https://github.com/oauth2-proxy/oauth2-proxy/blob/e6223383e5ff68709afe8e47d3e91b499e5802ad/docs/docs/configuration/overview.md) // if the page is gone. ProxyOpts map[string]string `json:"proxyOpts,omitempty"` }
OAuth2ProxySpec defines the desired state of OAuth2Proxy
func (*OAuth2ProxySpec) DeepCopy ¶
func (in *OAuth2ProxySpec) DeepCopy() *OAuth2ProxySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2ProxySpec.
func (*OAuth2ProxySpec) DeepCopyInto ¶
func (in *OAuth2ProxySpec) DeepCopyInto(out *OAuth2ProxySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type OAuth2ProxyStatus ¶
type OAuth2ProxyStatus struct { // INSERT ADDITIONAL STATUS FIELD - define observed state of cluster // Important: Run "make" to regenerate code after modifying this file Ready bool `json:"ready"` Message string `json:"message,omitempty"` }
OAuth2ProxyStatus defines the observed state of OAuth2Proxy
func (*OAuth2ProxyStatus) DeepCopy ¶
func (in *OAuth2ProxyStatus) DeepCopy() *OAuth2ProxyStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2ProxyStatus.
func (*OAuth2ProxyStatus) DeepCopyInto ¶
func (in *OAuth2ProxyStatus) DeepCopyInto(out *OAuth2ProxyStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PasswordRef ¶
type PasswordRef struct { *corev1.SecretKeySelector `json:",inline"` Namespace string `json:"namespace"` }
func (*PasswordRef) DeepCopy ¶
func (in *PasswordRef) DeepCopy() *PasswordRef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PasswordRef.
func (*PasswordRef) DeepCopyInto ¶
func (in *PasswordRef) DeepCopyInto(out *PasswordRef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Redis ¶
type Redis struct { Host string `json:"host"` PasswordRef PasswordRef `json:"passwordRef,omitempty"` }
func (*Redis) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Redis.
func (*Redis) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SessionStore ¶
type SessionStore struct {
Redis Redis `json:"redis"`
}
func (*SessionStore) DeepCopy ¶
func (in *SessionStore) DeepCopy() *SessionStore
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SessionStore.
func (*SessionStore) DeepCopyInto ¶
func (in *SessionStore) DeepCopyInto(out *SessionStore)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UserAuth ¶
type UserAuth struct { Username string `json:"username"` PasswordRef *PasswordRef `json:"passwordRef"` }
UserAuth allows the provider to authenticate with a known keycloak user/pass combination. Must have admin permissions.
func (*UserAuth) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserAuth.
func (*UserAuth) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.