groupsuffix

Documentation

Index

• Constants
• func New(apiGroupSuffix string) kubeclient.Middleware
• func Replace(baseAPIGroup, apiGroupSuffix string) (string, bool)
• func Unreplace(baseAPIGroup, apiGroupSuffix string) (string, bool)
• func Validate(apiGroupSuffix string) error
• type GroupData
  • func ConciergeAggregatedGroups(apiGroupSuffix string) (login, identity GroupData)
  • func SupervisorAggregatedGroups(apiGroupSuffix string) (clientSecret GroupData)
  • func (d GroupData) APIServiceName() string

Examples

• Replace (Loginv1alpha1)
• Replace (String)

Constants

const (
	PinnipedDefaultSuffix = "pinniped.dev"
)

Functions

func New

func New(apiGroupSuffix string) kubeclient.Middleware

func Replace

func Replace(baseAPIGroup, apiGroupSuffix string) (string, bool)

Replace constructs an API group from a baseAPIGroup and a parameterized apiGroupSuffix.

We assume that all baseAPIGroup's will end in "pinniped.dev", and therefore we can safely replace the reference to "pinniped.dev" with the provided apiGroupSuffix. If the provided baseAPIGroup does not end in "pinniped.dev", then this function will return an empty string and false.

See ExampleReplace_loginv1alpha1 and ExampleReplace_string for more information on input/output pairs.

Example (Loginv1alpha1)

s, _ := Replace(loginv1alpha1.GroupName, "tuna.fish.io")
fmt.Println(s)

Output:

login.concierge.tuna.fish.io

Example (String)

s, _ := Replace("idp.supervisor.pinniped.dev", "marlin.io")
fmt.Println(s)

Output:

idp.supervisor.marlin.io

func Unreplace

func Unreplace(baseAPIGroup, apiGroupSuffix string) (string, bool)

Unreplace is like performing an undo of Replace().

func Validate

func Validate(apiGroupSuffix string) error

Validate validates the provided apiGroupSuffix is usable as an API group suffix. Specifically, it makes sure that the provided apiGroupSuffix is a valid DNS-1123 subdomain with at least one dot, to match Kubernetes behavior.

Types

type GroupData

type GroupData schema.GroupVersion

func ConciergeAggregatedGroups

func ConciergeAggregatedGroups(apiGroupSuffix string) (login, identity GroupData)

func SupervisorAggregatedGroups

func SupervisorAggregatedGroups(apiGroupSuffix string) (clientSecret GroupData)

func (GroupData) APIServiceName

func (d GroupData) APIServiceName() string