Documentation ¶
Overview ¶
Package v1beta1 contains API Schema definitions for the kubic v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubic-project/dex-operator/pkg/apis/kubic +k8s:defaulter-gen=TypeMeta +groupName=kubic.opensuse.org
Package v1beta1 contains API Schema definitions for the kubic v1beta1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/kubic-project/dex-operator/pkg/apis/kubic +k8s:defaulter-gen=TypeMeta +groupName=kubic.opensuse.org
Index ¶
- Variables
- func Resource(resource string) schema.GroupResource
- type DexConfiguration
- type DexConfigurationList
- type DexConfigurationSpec
- type DexConfigurationStatus
- type DexStaticClient
- type DexStaticClientStatus
- type LDAPConnector
- type LDAPConnectorList
- type LDAPConnectorSpec
- type LDAPConnectorStatus
- type LDAPGroupSpec
- type LDAPUserSpec
Constants ¶
This section is empty.
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: "kubic.opensuse.org", Version: "v1beta1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} )
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource is required by pkg/client/listers/...
Types ¶
type DexConfiguration ¶
type DexConfiguration struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec DexConfigurationSpec `json:"spec,omitempty"` Status DexConfigurationStatus `json:"status,omitempty"` }
DexConfiguration is the Schema for the dexconfigurations API +k8s:openapi-gen=true
func (*DexConfiguration) DeepCopy ¶
func (in *DexConfiguration) DeepCopy() *DexConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DexConfiguration.
func (*DexConfiguration) DeepCopyInto ¶
func (in *DexConfiguration) DeepCopyInto(out *DexConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DexConfiguration) DeepCopyObject ¶
func (in *DexConfiguration) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type DexConfigurationList ¶
type DexConfigurationList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []DexConfiguration `json:"items"` }
DexConfigurationList contains a list of DexConfiguration
func (*DexConfigurationList) DeepCopy ¶
func (in *DexConfigurationList) DeepCopy() *DexConfigurationList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DexConfigurationList.
func (*DexConfigurationList) DeepCopyInto ¶
func (in *DexConfigurationList) DeepCopyInto(out *DexConfigurationList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DexConfigurationList) DeepCopyObject ¶
func (in *DexConfigurationList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type DexConfigurationSpec ¶
type DexConfigurationSpec struct { // External FQDNs for the Dex service (for certificates) // The first name/IP will be used as the "issuer" // +optional Names []string `json:"names,omitempty"` // the NodePort used y the Dex server // +optional NodePort int `json:"nodePort,omitempty"` // The image used for Dex // +optional Image string `json:"image,omitempty"` // number of replicas for the Dex deployment // +optional Replicas int `json:"replicas,omitempty"` // Static clients // +optional StaticClients []DexStaticClient `json:"staticClients,omitempty"` // Use an (already existing) certificate for the Dex service // +optional Certificate corev1.SecretReference `json:"certificate,omitempty"` // TODO: maybe this should be a property of the LDAPConnector // +optional AdminGroup string `json:"adminGroup,omitempty"` }
DexConfigurationSpec defines the desired state of DexConfiguration
func (*DexConfigurationSpec) DeepCopy ¶
func (in *DexConfigurationSpec) DeepCopy() *DexConfigurationSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DexConfigurationSpec.
func (*DexConfigurationSpec) DeepCopyInto ¶
func (in *DexConfigurationSpec) DeepCopyInto(out *DexConfigurationSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DexConfigurationStatus ¶
type DexConfigurationStatus struct { // Config is the (maybe namespaced) name of the ConfigMap Config string `json:"config,omitempty"` // Current deployment Deployment string `json:"deployment,omitempty"` // GeneratedCertificate is the certificate automatically generated for the Dex service // It will be empty when using the certificate provided in Spec.Certificate // It will be automatically removed when removing the DexConfiguration GeneratedCertificate corev1.SecretReference `json:"generatedCertificate,omitempty"` // Status of the static clients StaticClients []DexStaticClientStatus `json:"staticClients,omitempty"` // Number of connectors currently installed NumConnectors int `json:"numConnectors,omitempty"` }
DexConfigurationStatus defines the observed state of DexConfiguration
func (*DexConfigurationStatus) DeepCopy ¶
func (in *DexConfigurationStatus) DeepCopy() *DexConfigurationStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DexConfigurationStatus.
func (*DexConfigurationStatus) DeepCopyInto ¶
func (in *DexConfigurationStatus) DeepCopyInto(out *DexConfigurationStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DexStaticClient ¶
type DexStaticClient struct { Name string `json:"name,omitempty"` // The redirect URLs // +optional RedirectURLs []string `json:"redirectURLs,omitempty"` // +optional Public bool `json:"public,omitempty"` }
DexStaticClient struct
func (*DexStaticClient) DeepCopy ¶
func (in *DexStaticClient) DeepCopy() *DexStaticClient
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DexStaticClient.
func (*DexStaticClient) DeepCopyInto ¶
func (in *DexStaticClient) DeepCopyInto(out *DexStaticClient)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DexStaticClientStatus ¶
type DexStaticClientStatus struct { Name string `json:"name,omitempty"` // The redirect URLs // +optional RedirectURLs []string `json:"redirectURLs,omitempty"` // Shared, static password generated Password corev1.SecretReference `json:"password,omitempty"` // +optional Public bool `json:"public,omitempty"` }
DexStaticClientStatus struct
func (*DexStaticClientStatus) DeepCopy ¶
func (in *DexStaticClientStatus) DeepCopy() *DexStaticClientStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DexStaticClientStatus.
func (*DexStaticClientStatus) DeepCopyInto ¶
func (in *DexStaticClientStatus) DeepCopyInto(out *DexStaticClientStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type LDAPConnector ¶
type LDAPConnector struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec LDAPConnectorSpec `json:"spec,omitempty"` Status LDAPConnectorStatus `json:"status,omitempty"` }
LDAPConnector is the Schema for the ldapconnectors API +k8s:openapi-gen=true
func (*LDAPConnector) DeepCopy ¶
func (in *LDAPConnector) DeepCopy() *LDAPConnector
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LDAPConnector.
func (*LDAPConnector) DeepCopyInto ¶
func (in *LDAPConnector) DeepCopyInto(out *LDAPConnector)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*LDAPConnector) DeepCopyObject ¶
func (in *LDAPConnector) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type LDAPConnectorList ¶
type LDAPConnectorList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []LDAPConnector `json:"items"` }
LDAPConnectorList contains a list of LDAPConnector
func (*LDAPConnectorList) DeepCopy ¶
func (in *LDAPConnectorList) DeepCopy() *LDAPConnectorList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LDAPConnectorList.
func (*LDAPConnectorList) DeepCopyInto ¶
func (in *LDAPConnectorList) DeepCopyInto(out *LDAPConnectorList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*LDAPConnectorList) DeepCopyObject ¶
func (in *LDAPConnectorList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type LDAPConnectorSpec ¶
type LDAPConnectorSpec struct { Name string `json:"name,omitempty"` ID string `json:"id,omitempty"` // Host and optional port of the LDAP server in the form "host:port". // If the port is not supplied, it will be guessed based on "insecureNoSSL", // and "startTLS" flags. 389 for insecure or StartTLS connections, 636 // otherwise. Server string `json:"server,omitempty"` // The DN and password for an application service account. The connector uses // these credentials to search for users and groups. Not required if the LDAP // server provides access for anonymous auth. // Please note that if the bind password contains a `$`, it has to be saved in an // environment variable which should be given as the value to `bindPW`. // bindDN: uid=seviceaccount,cn=users,dc=example,dc=com // bindPW: password // +optional BindDN string `json:"bindDn,omitempty"` // +optional BindPW string `json:"bindPw,omitempty"` // +optional UsernamePrompt string `json:"usernamePrompt,omitempty"` // When connecting to the server, connect using the ldap:// protocol then issue // a StartTLS command. If unspecified, connections will use the ldaps:// protocol // +optional StartTLS bool `json:"startTLS,omitempty"` // Path to a trusted root certificate file. Default: use the host's root CA. // +optional RootCAData string `json:"rootCAData,omitempty"` // +optional User LDAPUserSpec `json:"user,omitempty"` // +optional Group LDAPGroupSpec `json:"group,omitempty"` }
LDAPConnectorSpec defines the desired state of LDAPConnector
func (*LDAPConnectorSpec) DeepCopy ¶
func (in *LDAPConnectorSpec) DeepCopy() *LDAPConnectorSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LDAPConnectorSpec.
func (*LDAPConnectorSpec) DeepCopyInto ¶
func (in *LDAPConnectorSpec) DeepCopyInto(out *LDAPConnectorSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type LDAPConnectorStatus ¶
type LDAPConnectorStatus struct { }
LDAPConnectorStatus defines the observed state of LDAPConnector
func (*LDAPConnectorStatus) DeepCopy ¶
func (in *LDAPConnectorStatus) DeepCopy() *LDAPConnectorStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LDAPConnectorStatus.
func (*LDAPConnectorStatus) DeepCopyInto ¶
func (in *LDAPConnectorStatus) DeepCopyInto(out *LDAPConnectorStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type LDAPGroupSpec ¶
type LDAPGroupSpec struct { // BaseDN to start the search from. It will translate to the query // "(&(objectClass=group)(member=<user uid>))". BaseDN string `json:"baseDn,omitempty"` // Optional filter to apply when searching the directory. Filter string `json:"filter,omitempty"` // Following two fields are used to match a user to a group. It adds an additional // requirement to the filter that an attribute in the group must match the user's // attribute value. UserAttr string `json:"userAttr,omitempty"` GroupAttr string `json:"groupAttr,omitempty"` // Represents group name. // +optional NameAttr string `json:"nameAttr,omitempty"` }
LDAPGroupSpec search queries for groups given a user entry.
func (*LDAPGroupSpec) DeepCopy ¶
func (in *LDAPGroupSpec) DeepCopy() *LDAPGroupSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LDAPGroupSpec.
func (*LDAPGroupSpec) DeepCopyInto ¶
func (in *LDAPGroupSpec) DeepCopyInto(out *LDAPGroupSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type LDAPUserSpec ¶
type LDAPUserSpec struct { // BaseDN to start the search from. It will translate to the query // "(&(objectClass=person)(uid=<username>))". BaseDN string `json:"baseDn,omitempty"` // Optional filter to apply when searching the directory. // +optional Filter string `json:"filter,omitempty"` // username attribute used for comparing user entries. This will be translated // and combined with the other filter as "(<attr>=<username>)". Username string `json:"username,omitempty"` // String representation of the user. IDAttr string `json:"idAttr,omitempty"` // Required. Attribute to map to Email EmailAttr string `json:"emailAttr,omitempty"` // Maps to display name of users. No default value. // +optional NameAttr string `json:"nameAttr,omitempty"` }
LDAPUserSpec maps a username and password entered by a user to a LDAP entry.
func (*LDAPUserSpec) DeepCopy ¶
func (in *LDAPUserSpec) DeepCopy() *LDAPUserSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LDAPUserSpec.
func (*LDAPUserSpec) DeepCopyInto ¶
func (in *LDAPUserSpec) DeepCopyInto(out *LDAPUserSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.