v3

Documentation

Overview

Package v3 is the v3 version of the API. +groupName=auth.containership.io +groupGoName=ContainershipAuth

Index

• Variables
• func Resource(resource string) schema.GroupResource
• type AuthorizationRole
  • func (in *AuthorizationRole) DeepCopy() *AuthorizationRole
  • func (in *AuthorizationRole) DeepCopyInto(out *AuthorizationRole)
  • func (in *AuthorizationRole) DeepCopyObject() runtime.Object
• type AuthorizationRoleBinding
  • func (in *AuthorizationRoleBinding) DeepCopy() *AuthorizationRoleBinding
  • func (in *AuthorizationRoleBinding) DeepCopyInto(out *AuthorizationRoleBinding)
  • func (in *AuthorizationRoleBinding) DeepCopyObject() runtime.Object
• type AuthorizationRoleBindingList
  • func (in *AuthorizationRoleBindingList) DeepCopy() *AuthorizationRoleBindingList
  • func (in *AuthorizationRoleBindingList) DeepCopyInto(out *AuthorizationRoleBindingList)
  • func (in *AuthorizationRoleBindingList) DeepCopyObject() runtime.Object
• type AuthorizationRoleBindingSpec
  • func (in *AuthorizationRoleBindingSpec) DeepCopy() *AuthorizationRoleBindingSpec
  • func (in *AuthorizationRoleBindingSpec) DeepCopyInto(out *AuthorizationRoleBindingSpec)
• type AuthorizationRoleBindingType
• type AuthorizationRoleList
  • func (in *AuthorizationRoleList) DeepCopy() *AuthorizationRoleList
  • func (in *AuthorizationRoleList) DeepCopyInto(out *AuthorizationRoleList)
  • func (in *AuthorizationRoleList) DeepCopyObject() runtime.Object
• type AuthorizationRoleSpec
  • func (in *AuthorizationRoleSpec) DeepCopy() *AuthorizationRoleSpec
  • func (in *AuthorizationRoleSpec) DeepCopyInto(out *AuthorizationRoleSpec)
• type AuthorizationRuleSpec
  • func (in *AuthorizationRuleSpec) DeepCopy() *AuthorizationRuleSpec
  • func (in *AuthorizationRuleSpec) DeepCopyInto(out *AuthorizationRuleSpec)
• type AuthorizationRuleType

Variables

var (
	// SchemeBuilder is used to add functions to the API dynamically
	SchemeBuilder runtime.SchemeBuilder

	// AddToScheme adds functions to the Scheme
	AddToScheme = localSchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: authcontainershipio.GroupName, Version: "v3"}

SchemeGroupVersion is group version used to register these objects

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type AuthorizationRole

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

	Spec AuthorizationRoleSpec `json:"spec"`
}

AuthorizationRole describes an authorization role in Containership Cloud.

func (*AuthorizationRole) DeepCopy

func (in *AuthorizationRole) DeepCopy() *AuthorizationRole

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

func (*AuthorizationRole) DeepCopyInto

func (in *AuthorizationRole) DeepCopyInto(out *AuthorizationRole)

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

func (*AuthorizationRole) DeepCopyObject

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

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

type AuthorizationRoleBinding

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

	Spec AuthorizationRoleBindingSpec `json:"spec"`
}

AuthorizationRoleBinding describes an authorization role binding in Containership Cloud.

func (*AuthorizationRoleBinding) DeepCopy

func (in *AuthorizationRoleBinding) DeepCopy() *AuthorizationRoleBinding

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

func (*AuthorizationRoleBinding) DeepCopyInto

func (in *AuthorizationRoleBinding) DeepCopyInto(out *AuthorizationRoleBinding)

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

func (*AuthorizationRoleBinding) DeepCopyObject

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

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

type AuthorizationRoleBindingList

type AuthorizationRoleBindingList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []AuthorizationRoleBinding `json:"items"`
}

AuthorizationRoleBindingList is a list of AuthorizationRoleBindings.

func (*AuthorizationRoleBindingList) DeepCopy

func (in *AuthorizationRoleBindingList) DeepCopy() *AuthorizationRoleBindingList

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

func (*AuthorizationRoleBindingList) DeepCopyInto

func (in *AuthorizationRoleBindingList) DeepCopyInto(out *AuthorizationRoleBindingList)

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

func (*AuthorizationRoleBindingList) DeepCopyObject

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

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

type AuthorizationRoleBindingSpec

type AuthorizationRoleBindingSpec struct {
	ID                  string                       `json:"id"`
	CreatedAt           string                       `json:"created_at"`
	UpdatedAt           string                       `json:"updated_at"`
	OrganizationID      string                       `json:"organization_id"`
	OwnerID             string                       `json:"owner_id"`
	Type                AuthorizationRoleBindingType `json:"type"`
	AuthorizationRoleID string                       `json:"authorization_role_id"`

	// The following are conditionally required depending on the Type
	UserID    string `json:"user_id,omitempty"`
	TeamID    string `json:"team_id,omitempty"`
	ClusterID string `json:"cluster_id,omitempty"`
	Namespace string `json:"namespace,omitempty"`
}

AuthorizationRoleBindingSpec is the spec for a Containership Cloud auth role binding.

func (*AuthorizationRoleBindingSpec) DeepCopy

func (in *AuthorizationRoleBindingSpec) DeepCopy() *AuthorizationRoleBindingSpec

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

func (*AuthorizationRoleBindingSpec) DeepCopyInto

func (in *AuthorizationRoleBindingSpec) DeepCopyInto(out *AuthorizationRoleBindingSpec)

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

type AuthorizationRoleBindingType

type AuthorizationRoleBindingType string

AuthorizationRoleBindingType specifies the type of rule

const (
	// AuthorizationRoleBindingTypeUser binds a role to an individual user
	AuthorizationRoleBindingTypeUser AuthorizationRoleBindingType = "UserBinding"
	// AuthorizationRoleBindingTypeTeam binds a role to an entire team
	AuthorizationRoleBindingTypeTeam AuthorizationRoleBindingType = "TeamBinding"
)

type AuthorizationRoleList

type AuthorizationRoleList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []AuthorizationRole `json:"items"`
}

AuthorizationRoleList is a list of AuthorizationRoles.

func (*AuthorizationRoleList) DeepCopy

func (in *AuthorizationRoleList) DeepCopy() *AuthorizationRoleList

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

func (*AuthorizationRoleList) DeepCopyInto

func (in *AuthorizationRoleList) DeepCopyInto(out *AuthorizationRoleList)

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

func (*AuthorizationRoleList) DeepCopyObject

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

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

type AuthorizationRoleSpec

type AuthorizationRoleSpec struct {
	ID             string                  `json:"id"`
	CreatedAt      string                  `json:"created_at"`
	UpdatedAt      string                  `json:"updated_at"`
	OrganizationID string                  `json:"organization_id"`
	Name           string                  `json:"name"`
	Description    string                  `json:"description,omitempty"`
	OwnerID        string                  `json:"owner_id"`
	Rules          []AuthorizationRuleSpec `json:"rules"`
}

AuthorizationRoleSpec is the spec for a Containership Cloud auth role.

func (*AuthorizationRoleSpec) DeepCopy

func (in *AuthorizationRoleSpec) DeepCopy() *AuthorizationRoleSpec

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

func (*AuthorizationRoleSpec) DeepCopyInto

func (in *AuthorizationRoleSpec) DeepCopyInto(out *AuthorizationRoleSpec)

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

type AuthorizationRuleSpec

type AuthorizationRuleSpec struct {
	ID              string                `json:"id"`
	CreatedAt       string                `json:"created_at"`
	UpdatedAt       string                `json:"updated_at"`
	OrganizationID  string                `json:"organization_id"`
	Name            string                `json:"name"`
	Description     string                `json:"description,omitempty"`
	OwnerID         string                `json:"owner_id"`
	Type            AuthorizationRuleType `json:"type"`
	APIGroups       []string              `json:"api_groups,omitempty"`
	Resources       []string              `json:"resources"`
	ResourceNames   []string              `json:"resource_names"`
	Verbs           []string              `json:"verbs"`
	NonResourceURLs []string              `json:"non_resource_urls"`
}

AuthorizationRuleSpec is the spec for a Containership Cloud auth rule.

func (*AuthorizationRuleSpec) DeepCopy

func (in *AuthorizationRuleSpec) DeepCopy() *AuthorizationRuleSpec

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

func (*AuthorizationRuleSpec) DeepCopyInto

func (in *AuthorizationRuleSpec) DeepCopyInto(out *AuthorizationRuleSpec)

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

type AuthorizationRuleType

type AuthorizationRuleType string

AuthorizationRuleType specifies the type of rule

const (
	// AuthorizationRuleTypeKubernetes applies to Kubernetes
	AuthorizationRuleTypeKubernetes AuthorizationRuleType = "kubernetes"
	// AuthorizationRuleTypeContainership applies to Containership Cloud
	AuthorizationRuleTypeContainership AuthorizationRuleType = "containership"
)