v1alpha1

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 30, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

+k8s:deepcopy-gen=package,register +groupName=unikorn-cloud.org

Index

Constants

View Source 
const (
	// GroupName is the Kubernetes API group our resources belong to.
	GroupName = "unikorn-cloud.org"
	// GroupVersion is the version of our custom resources.
	GroupVersion = "v1alpha1"
	// Group is group/version of our resources.
	Group = GroupName + "/" + GroupVersion
)

Variables

View Source 
var (
	// SchemeGroupVersion defines the GV of our resources.
	//nolint:gochecknoglobals
	SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: GroupVersion}

	// SchemeBuilder creates a mapping between GVK and type.
	//nolint:gochecknoglobals
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}

	// AddToScheme adds our GVK to resource mappings to an existing scheme.
	//nolint:gochecknoglobals
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func Resource 

func Resource(resource string) schema.GroupResource

Resource maps a resource type to a group resource.

Types

type OAuth2Client 

type OAuth2Client struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              OAuth2ClientSpec   `json:"spec"`
	Status            OAuth2ClientStatus `json:"status,omitempty"`
}

OAuth2Client describes an oauth2 client. +genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:resource:scope=Namespaced,categories=unikorn +kubebuilder:printcolumn:name="client id",type="string",JSONPath=".spec.id" +kubebuilder:printcolumn:name="redirect uri",type="string",JSONPath=".spec.redirectUri" +kubebuilder:printcolumn:name="age",type="date",JSONPath=".metadata.creationTimestamp"

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 is a typed list of frontend clients. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

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 OAuth2ClientSpec 

type OAuth2ClientSpec struct {
	// ID uniquely identifes the client.
	ID string `json:"id"`
	// RedirectURI is the URI to pass control back to the client.
	RedirectURI string `json:"redirectUri"`
}

OAuth2ClientSpec defines the required configuration for the client.

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 {
}

OAuth2ClientStatus defines the status of the client.

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 OAuth2Mapping 

type OAuth2Mapping struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              OAuth2MappingSpec   `json:"spec"`
	Status            OAuth2MappingStatus `json:"status,omitempty"`
}

OAuth2Mapping describes an identity mapping. The main job of this type is to take an email address identity, extract the domain and use it to resolve an identity provider. It also is the place where users within that domain can be allowed based on groups/claims offered by that identity provider to limit access. +genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:resource:scope=Namespaced,categories=unikorn +kubebuilder:printcolumn:name="domain",type="string",JSONPath=".spec.domain" +kubebuilder:printcolumn:name="provider",type="string",JSONPath=".spec.providerName" +kubebuilder:printcolumn:name="age",type="date",JSONPath=".metadata.creationTimestamp"

func (*OAuth2Mapping) DeepCopy 

func (in *OAuth2Mapping) DeepCopy() *OAuth2Mapping

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2Mapping.

func (*OAuth2Mapping) DeepCopyInto 

func (in *OAuth2Mapping) DeepCopyInto(out *OAuth2Mapping)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*OAuth2Mapping) DeepCopyObject 

func (in *OAuth2Mapping) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type OAuth2MappingList 

type OAuth2MappingList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []OAuth2Mapping `json:"items"`
}

OAuth2MappingList is a typed list of identity mappings. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*OAuth2MappingList) DeepCopy 

func (in *OAuth2MappingList) DeepCopy() *OAuth2MappingList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2MappingList.

func (*OAuth2MappingList) DeepCopyInto 

func (in *OAuth2MappingList) DeepCopyInto(out *OAuth2MappingList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*OAuth2MappingList) DeepCopyObject 

func (in *OAuth2MappingList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type OAuth2MappingSpec 

type OAuth2MappingSpec struct {
	// Domain is used by unikorn-identity to map an end-user provided
	// email address to an identity provider.
	Domain string `json:"domain"`
	// ProviderName is the name of an oauth2/oidc provider.
	ProviderName string `json:"providerName"`
}

OAuth2MappingSpec defines the required configuration for the server.

func (*OAuth2MappingSpec) DeepCopy 

func (in *OAuth2MappingSpec) DeepCopy() *OAuth2MappingSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2MappingSpec.

func (*OAuth2MappingSpec) DeepCopyInto 

func (in *OAuth2MappingSpec) DeepCopyInto(out *OAuth2MappingSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OAuth2MappingStatus 

type OAuth2MappingStatus struct {
}

OAuth2MappingStatus defines the status of the server.

func (*OAuth2MappingStatus) DeepCopy 

func (in *OAuth2MappingStatus) DeepCopy() *OAuth2MappingStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2MappingStatus.

func (*OAuth2MappingStatus) DeepCopyInto 

func (in *OAuth2MappingStatus) DeepCopyInto(out *OAuth2MappingStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OAuth2Provider 

type OAuth2Provider struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              OAuth2ProviderSpec   `json:"spec"`
	Status            OAuth2ProviderStatus `json:"status,omitempty"`
}

OAuth2Provider describes an oauth2 provider. +genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +kubebuilder:resource:scope=Namespaced,categories=unikorn +kubebuilder:printcolumn:name="display name",type="string",JSONPath=".spec.displayName" +kubebuilder:printcolumn:name="issuer",type="string",JSONPath=".spec.issuer" +kubebuilder:printcolumn:name="client ID",type="string",JSONPath=".spec.clientID" +kubebuilder:printcolumn:name="age",type="date",JSONPath=".metadata.creationTimestamp"

func (*OAuth2Provider) DeepCopy 

func (in *OAuth2Provider) DeepCopy() *OAuth2Provider

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2Provider.

func (*OAuth2Provider) DeepCopyInto 

func (in *OAuth2Provider) DeepCopyInto(out *OAuth2Provider)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*OAuth2Provider) DeepCopyObject 

func (in *OAuth2Provider) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type OAuth2ProviderList 

type OAuth2ProviderList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []OAuth2Provider `json:"items"`
}

OAuth2ProviderList is a typed list of backend servers. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*OAuth2ProviderList) DeepCopy 

func (in *OAuth2ProviderList) DeepCopy() *OAuth2ProviderList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2ProviderList.

func (*OAuth2ProviderList) DeepCopyInto 

func (in *OAuth2ProviderList) DeepCopyInto(out *OAuth2ProviderList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*OAuth2ProviderList) DeepCopyObject 

func (in *OAuth2ProviderList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type OAuth2ProviderSpec 

type OAuth2ProviderSpec struct {
	// HumanReadableName is a user readable issuer name.
	HumanReadableName string `json:"displayName"`
	// The issuer is typically provided by the identity provider as an
	// OIDC discovery endpoint e.g. https://accounts.google.com.
	// This will be used to verify issued JWTs have the same "iss" claim.
	Issuer string `json:"issuer"`
	// ClientID is the assigned client identifier.
	ClientID string `json:"clientID"`
	// ClientSecret is created by the IdP for token exchange.
	ClientSecret string `json:"clientSecret"`
}

OAuth2ProviderSpec defines the required configuration for an oauth2 provider.

func (*OAuth2ProviderSpec) DeepCopy 

func (in *OAuth2ProviderSpec) DeepCopy() *OAuth2ProviderSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2ProviderSpec.

func (*OAuth2ProviderSpec) DeepCopyInto 

func (in *OAuth2ProviderSpec) DeepCopyInto(out *OAuth2ProviderSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OAuth2ProviderStatus 

type OAuth2ProviderStatus struct {
}

OAuth2ProviderStatus defines the status of the server.

func (*OAuth2ProviderStatus) DeepCopy 

func (in *OAuth2ProviderStatus) DeepCopy() *OAuth2ProviderStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OAuth2ProviderStatus.

func (*OAuth2ProviderStatus) DeepCopyInto 

func (in *OAuth2ProviderStatus) DeepCopyInto(out *OAuth2ProviderStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.