v1

Documentation

Overview

Package v1 is the v1 version of the API. +groupName=jenkins.io

Index

• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type CookieSpec
  • func (in *CookieSpec) DeepCopy() *CookieSpec
  • func (in *CookieSpec) DeepCopyInto(out *CookieSpec)
• type SSO
  • func (in *SSO) DeepCopy() *SSO
  • func (in *SSO) DeepCopyInto(out *SSO)
  • func (in *SSO) DeepCopyObject() runtime.Object
• type SSOList
  • func (in *SSOList) DeepCopy() *SSOList
  • func (in *SSOList) DeepCopyInto(out *SSOList)
  • func (in *SSOList) DeepCopyObject() runtime.Object
• type SSOSpec
  • func (in *SSOSpec) DeepCopy() *SSOSpec
  • func (in *SSOSpec) DeepCopyInto(out *SSOSpec)
• type SSOStatus
  • func (in *SSOStatus) DeepCopy() *SSOStatus
  • func (in *SSOStatus) DeepCopyInto(out *SSOStatus)

Variables

var (
	// SchemeBuilder for building the schema
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme helper
	AddToScheme = SchemeBuilder.AddToScheme

	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: jenkinsio.GroupName, Version: jenkinsio.Version}

	// SSOKind is the SSO CRD kind
	SSOKind = "SSO"
)

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type CookieSpec

type CookieSpec struct {
	// Cookie name
	Name string `json:"name,omitempty"`
	// Expiration time of the cookie
	Expire string `json:"expire,omitempty"`
	// Refresh time of the cookie
	Refresh string `json:"refresh,omitempty"`
	// Cookie is only send over a HTTPS connection
	Secure bool `json:"secure,omitempty"`
	// Cookie is not readable from JavaScript
	HTTPOnly bool `json:"httpOnly,omitempty"`
}

CookieSpec is the specification of a cookie for a Single Sign-On resource

func (*CookieSpec) DeepCopy

func (in *CookieSpec) DeepCopy() *CookieSpec

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

func (*CookieSpec) DeepCopyInto

func (in *CookieSpec) DeepCopyInto(out *CookieSpec)

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

type SSO

type SSO struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	Spec   SSOSpec   `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
	Status SSOStatus `json:"status,omitempty" protobuf:"bytes,2,opt,name=status"`
}

SSO represent Single Sign-On required to create a OIDC client in dex

func (*SSO) DeepCopy

func (in *SSO) DeepCopy() *SSO

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

func (*SSO) DeepCopyInto

func (in *SSO) DeepCopyInto(out *SSO)

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

func (*SSO) DeepCopyObject

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

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

type SSOList

type SSOList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []SSO `json:"items"`
}

SSOList represents a list of Single Sign-On Kubernetes objects

func (*SSOList) DeepCopy

func (in *SSOList) DeepCopy() *SSOList

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

func (*SSOList) DeepCopyInto

func (in *SSOList) DeepCopyInto(out *SSOList)

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

func (*SSOList) DeepCopyObject

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

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

type SSOSpec

type SSOSpec struct {
	// OIDCIssuerURL URL of dex IdP
	OIDCIssuerURL string `json:"oidcIssuerUrl,omitempty"`
	// Name of the upstream service for which the SSO is created
	UpstreamService string `json:"upstreamService,omitempty"`
	// Domain name under which the SSO service will be exposed
	Domain string `json:"domain,omitempty"`
	// cert-manager issuer name
	CertIssuerName string `json:"certIssuerName,omitempty"`
	// Docker image for oauth2_proxy
	ProxyImage string `json:"proxyImage,omitempty"`
	// Docker image tag for oauth2_proxy
	ProxyImageTag string `json:"proxyImageTag,omitempty"`
	// Resource requirements for oauth2_proxy pod
	ProxyResources v1.ResourceRequirements `json:"proxyResources,omitempty"`
	// Indicate if the access token should be forwarded to the upstream service
	ForwardToken bool `json:"forwardToken,omitempty"`
	// CookieSpec cookie specifications
	CookieSpec CookieSpec `json:"cookieSpec,omitempty"`
}

SSOSpec is the specification of a Single Sing-On resource

func (*SSOSpec) DeepCopy

func (in *SSOSpec) DeepCopy() *SSOSpec

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

func (*SSOSpec) DeepCopyInto

func (in *SSOSpec) DeepCopyInto(out *SSOSpec)

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

type SSOStatus

type SSOStatus struct {
	// OIDC client ID created in dex
	ClientID string `json:"clientId,omitempty" protobuf:"bytes,2,opt,name=clientId"`
	// Initialized indicated if the SSO was configured in dex and oauth2_proxy
	Initialized bool `json:"initialized,omitempty" protobuf:"bytes,2,opt,name=initialized"`
}

SSOStatus is the status of an Single Sign-On resource

func (*SSOStatus) DeepCopy

func (in *SSOStatus) DeepCopy() *SSOStatus

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

func (*SSOStatus) DeepCopyInto

func (in *SSOStatus) DeepCopyInto(out *SSOStatus)

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