v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the irsa v1alpha1 API group +kubebuilder:object:generate=true +groupName=irsa.kkb0318.github.io

Index

• Constants
• Variables
• func HasConditionReason(cond *metav1.Condition, reasons ...string) bool
• func IsSelfHostedReadyConditionTrue(irsa IRSASetup) bool
• func SelfHostedReadyStatus(irsa IRSASetup) *metav1.Condition
• type Auth
  • func (in *Auth) DeepCopy() *Auth
  • func (in *Auth) DeepCopyInto(out *Auth)
• type Discovery
  • func (in *Discovery) DeepCopy() *Discovery
  • func (in *Discovery) DeepCopyInto(out *Discovery)
• type IRSASetup
  • func SelfHostedStatusNotReady(irsa IRSASetup, reason, message string) IRSASetup
  • func SetupSelfHostedStatusReady(irsa IRSASetup, reason, message string) IRSASetup
  • func (in *IRSASetup) DeepCopy() *IRSASetup
  • func (in *IRSASetup) DeepCopyInto(out *IRSASetup)
  • func (in *IRSASetup) DeepCopyObject() runtime.Object
  • func (in *IRSASetup) GetSelfhostedStatusConditions() *[]metav1.Condition
• type IRSASetupList
  • func (in *IRSASetupList) DeepCopy() *IRSASetupList
  • func (in *IRSASetupList) DeepCopyInto(out *IRSASetupList)
  • func (in *IRSASetupList) DeepCopyObject() runtime.Object
• type IRSASetupSpec
  • func (in *IRSASetupSpec) DeepCopy() *IRSASetupSpec
  • func (in *IRSASetupSpec) DeepCopyInto(out *IRSASetupSpec)
• type IRSASetupStatus
  • func (in *IRSASetupStatus) DeepCopy() *IRSASetupStatus
  • func (in *IRSASetupStatus) DeepCopyInto(out *IRSASetupStatus)
• type S3Discovery
  • func (in *S3Discovery) DeepCopy() *S3Discovery
  • func (in *S3Discovery) DeepCopyInto(out *S3Discovery)
• type SecretRef
  • func (in *SecretRef) DeepCopy() *SecretRef
  • func (in *SecretRef) DeepCopyInto(out *SecretRef)
• type SelfHostedReason

Constants

const (
	// IRSASetupKind represents the kind attribute of an IRSASetup resource.
	IRSASetupKind = "IRSASetup"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "irsa.kkb0318.github.io", Version: "v1alpha1"}

	// 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

func HasConditionReason

func HasConditionReason(cond *metav1.Condition, reasons ...string) bool

HasConditionReason

func IsSelfHostedReadyConditionTrue

func IsSelfHostedReadyConditionTrue(irsa IRSASetup) bool

func SelfHostedReadyStatus

func SelfHostedReadyStatus(irsa IRSASetup) *metav1.Condition

SelfHostedReadyStatus

Types

type Auth

type Auth struct {
	// SecretRef specifies the reference to the Kubernetes secret containing authentication details.
	SecretRef SecretRef `json:"secretRef"`
}

Auth holds the authentication configuration details.

func (*Auth) DeepCopy

func (in *Auth) DeepCopy() *Auth

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

func (*Auth) DeepCopyInto

func (in *Auth) DeepCopyInto(out *Auth)

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

type Discovery

type Discovery struct {
	// S3 specifies the AWS S3 bucket details where the OIDC provider's discovery information is hosted.
	S3 S3Discovery `json:"s3,omitempty"`
}

Discovery holds the configuration for IdP Discovery, which is crucial for locating the OIDC provider in a self-hosted environment.

func (*Discovery) DeepCopy

func (in *Discovery) DeepCopy() *Discovery

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

func (*Discovery) DeepCopyInto

func (in *Discovery) DeepCopyInto(out *Discovery)

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

type IRSASetup

type IRSASetup struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   IRSASetupSpec   `json:"spec,omitempty"`
	Status IRSASetupStatus `json:"status,omitempty"`
}

IRSASetup represents a configuration for setting up IAM Roles for Service Accounts (IRSA) in a Kubernetes cluster.

func SelfHostedStatusNotReady

func SelfHostedStatusNotReady(irsa IRSASetup, reason, message string) IRSASetup

func SetupSelfHostedStatusReady

func SetupSelfHostedStatusReady(irsa IRSASetup, reason, message string) IRSASetup

func (*IRSASetup) DeepCopy

func (in *IRSASetup) DeepCopy() *IRSASetup

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

func (*IRSASetup) DeepCopyInto

func (in *IRSASetup) DeepCopyInto(out *IRSASetup)

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

func (*IRSASetup) DeepCopyObject

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

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

func (*IRSASetup) GetSelfhostedStatusConditions

func (in *IRSASetup) GetSelfhostedStatusConditions() *[]metav1.Condition

GetStatusConditions returns a pointer to the Status.Conditions slice

type IRSASetupList

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

IRSASetupList contains a list of IRSASetup

func (*IRSASetupList) DeepCopy

func (in *IRSASetupList) DeepCopy() *IRSASetupList

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

func (*IRSASetupList) DeepCopyInto

func (in *IRSASetupList) DeepCopyInto(out *IRSASetupList)

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

func (*IRSASetupList) DeepCopyObject

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

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

type IRSASetupSpec

type IRSASetupSpec struct {
	// Mode specifies the mode of operation. Can be either "selfhosted" or "eks".
	Mode string `json:"mode"`

	// Discovery configures the IdP Discovery process, essential for setting up IRSA by locating
	// the OIDC provider information.
	Discovery Discovery `json:"discovery"`

	// Auth contains authentication configuration details.
	Auth Auth `json:"auth,omitempty"`
}

IRSASetupSpec defines the desired state of IRSASetup

func (*IRSASetupSpec) DeepCopy

func (in *IRSASetupSpec) DeepCopy() *IRSASetupSpec

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

func (*IRSASetupSpec) DeepCopyInto

func (in *IRSASetupSpec) DeepCopyInto(out *IRSASetupSpec)

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

type IRSASetupStatus

type IRSASetupStatus struct {
	SelfHostedSetup []metav1.Condition `json:"selfHostedSetup,omitempty"`
}

IRSASetupStatus defines the observed state of IRSASetup

func (*IRSASetupStatus) DeepCopy

func (in *IRSASetupStatus) DeepCopy() *IRSASetupStatus

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

func (*IRSASetupStatus) DeepCopyInto

func (in *IRSASetupStatus) DeepCopyInto(out *IRSASetupStatus)

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

type S3Discovery

type S3Discovery struct {
	// Region denotes the AWS region where the S3 bucket is located.
	Region string `json:"region"`

	// BucketName is the name of the S3 bucket that hosts the OIDC discovery information.
	BucketName string `json:"bucketName"`
}

S3Discovery contains the specifics of the S3 bucket used for hosting OIDC provider discovery information.

func (*S3Discovery) DeepCopy

func (in *S3Discovery) DeepCopy() *S3Discovery

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

func (*S3Discovery) DeepCopyInto

func (in *S3Discovery) DeepCopyInto(out *S3Discovery)

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

type SecretRef

type SecretRef struct {
	// Name specifies the name of the secret.
	Name string `json:"name"`

	// Namespace specifies the namespace of the secret.
	Namespace string `json:"namespace,omitempty"`
}

SecretRef contains the reference to a Kubernetes secret.

func (*SecretRef) DeepCopy

func (in *SecretRef) DeepCopy() *SecretRef

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

func (*SecretRef) DeepCopyInto

func (in *SecretRef) DeepCopyInto(out *SecretRef)

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

type SelfHostedReason

type SelfHostedReason string

const (
	SelfHostedReasonFailedOidc SelfHostedReason = "SelfHostedSetupFailedOidcCreation"
	SelfHostedReasonFailedKeys SelfHostedReason = "SelfHostedSetupFailedKeysCreation"
	SelfHostedReasonReady      SelfHostedReason = "SelfHostedSetupReady"
)