Documentation ¶
Overview ¶
Package v3 is the v3 version of the API. +groupName=containership.io
Index ¶
- Variables
- func Resource(resource string) schema.GroupResource
- type AuthTokenDef
- type ClusterLabel
- type ClusterLabelList
- type ClusterLabelSpec
- type Plugin
- type PluginList
- type PluginSpec
- type PluginType
- type Registry
- type RegistryList
- type RegistrySpec
- type SSHKeySpec
- type User
- type UserList
- type UserSpec
Constants ¶
This section is empty.
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: containershipio.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 AuthTokenDef ¶
type AuthTokenDef struct { Token string `json:"token"` Endpoint string `json:"endpoint"` Type string `json:"type"` Expires string `json:"expires"` }
AuthTokenDef is the def for an auth token
func (*AuthTokenDef) DeepCopy ¶
func (in *AuthTokenDef) DeepCopy() *AuthTokenDef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthTokenDef.
func (*AuthTokenDef) DeepCopyInto ¶
func (in *AuthTokenDef) DeepCopyInto(out *AuthTokenDef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterLabel ¶
type ClusterLabel struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec ClusterLabelSpec `json:"spec"` }
ClusterLabel describes a cluster label in Containership Cloud.
func (*ClusterLabel) DeepCopy ¶
func (in *ClusterLabel) DeepCopy() *ClusterLabel
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterLabel.
func (*ClusterLabel) DeepCopyInto ¶
func (in *ClusterLabel) DeepCopyInto(out *ClusterLabel)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterLabel) DeepCopyObject ¶
func (in *ClusterLabel) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterLabelList ¶
type ClusterLabelList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []ClusterLabel `json:"items"` }
ClusterLabelList is a list of ClusterLabels.
func (*ClusterLabelList) DeepCopy ¶
func (in *ClusterLabelList) DeepCopy() *ClusterLabelList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterLabelList.
func (*ClusterLabelList) DeepCopyInto ¶
func (in *ClusterLabelList) DeepCopyInto(out *ClusterLabelList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterLabelList) DeepCopyObject ¶
func (in *ClusterLabelList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterLabelSpec ¶
type ClusterLabelSpec struct { ID string `json:"id"` CreatedAt string `json:"created_at"` UpdatedAt string `json:"updated_at"` Key string `json:"key"` Value string `json:"value"` }
ClusterLabelSpec is the spec for a Containership Cloud ClusterLabel.
func (*ClusterLabelSpec) DeepCopy ¶
func (in *ClusterLabelSpec) DeepCopy() *ClusterLabelSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterLabelSpec.
func (*ClusterLabelSpec) DeepCopyInto ¶
func (in *ClusterLabelSpec) DeepCopyInto(out *ClusterLabelSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Plugin ¶
type Plugin struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec PluginSpec `json:"spec"` }
Plugin describes a plugin added by Containership Cloud.
func (*Plugin) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Plugin.
func (*Plugin) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Plugin) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PluginList ¶
type PluginList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []Plugin `json:"items"` }
PluginList is a list of Plugins.
func (*PluginList) DeepCopy ¶
func (in *PluginList) DeepCopy() *PluginList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PluginList.
func (*PluginList) DeepCopyInto ¶
func (in *PluginList) DeepCopyInto(out *PluginList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PluginList) DeepCopyObject ¶
func (in *PluginList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PluginSpec ¶
type PluginSpec struct { ID string `json:"id"` AddedAt string `json:"added_at"` Description string `json:"description"` Type PluginType `json:"type"` Version string `json:"version"` Implementation string `json:"implementation"` }
PluginSpec is the spec for a Containership Cloud Plugin.
func (*PluginSpec) DeepCopy ¶
func (in *PluginSpec) DeepCopy() *PluginSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PluginSpec.
func (*PluginSpec) DeepCopyInto ¶
func (in *PluginSpec) DeepCopyInto(out *PluginSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PluginType ¶
type PluginType string
PluginType lets us group together plugins of different implentations
const ( // CloudControllerManager is a plugin type for interacting with a cloud provider CloudControllerManager PluginType = "cloud_controller_manager" // CNI is a generic type of supported network plugin CNI PluginType = "cni" // CSI is a generic type of plugin for interacting with a cloud providers storage CSI PluginType = "csi" // Logs is a generic type of supported plugin Logs PluginType = "logs" // Metrics is a generic type of supported plugin Metrics PluginType = "metrics" // Events is a generic type of event supported plugin Events PluginType = "events" )
type Registry ¶
type Registry struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec RegistrySpec `json:"spec"` }
Registry describes a registry attached to Containership Cloud.
func (*Registry) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Registry.
func (*Registry) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Registry) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RegistryList ¶
type RegistryList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []Registry `json:"items"` }
RegistryList is a list of Registries.
func (*RegistryList) DeepCopy ¶
func (in *RegistryList) DeepCopy() *RegistryList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RegistryList.
func (*RegistryList) DeepCopyInto ¶
func (in *RegistryList) DeepCopyInto(out *RegistryList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RegistryList) DeepCopyObject ¶
func (in *RegistryList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RegistrySpec ¶
type RegistrySpec struct { ID string `json:"id"` AddedAt string `json:"added_at"` Description string `json:"description"` Organization string `json:"organization_id"` Email string `json:"email"` Serveraddress string `json:"serveraddress"` Provider string `json:"provider"` Credentials map[string]string `json:"credentials"` Owner string `json:"owner"` AuthToken AuthTokenDef `json:"authToken,omitempty"` }
RegistrySpec is the spec for a Containership Cloud Registry.
func (*RegistrySpec) DeepCopy ¶
func (in *RegistrySpec) DeepCopy() *RegistrySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RegistrySpec.
func (*RegistrySpec) DeepCopyInto ¶
func (in *RegistrySpec) DeepCopyInto(out *RegistrySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SSHKeySpec ¶
type SSHKeySpec struct { ID string `json:"id"` Name string `json:"name"` Fingerprint string `json:"fingerprint"` Key string `json:"key"` // format: "<key_type> <key>" }
SSHKeySpec is the spec for an SSH Key.
func (*SSHKeySpec) DeepCopy ¶
func (in *SSHKeySpec) DeepCopy() *SSHKeySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SSHKeySpec.
func (*SSHKeySpec) DeepCopyInto ¶
func (in *SSHKeySpec) DeepCopyInto(out *SSHKeySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type User ¶
type User struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec UserSpec `json:"spec"` }
User describes a Containership Cloud user.
func (*User) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new User.
func (*User) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*User) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type UserList ¶
type UserList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []User `json:"items"` }
UserList is a list of Users.
func (*UserList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserList.
func (*UserList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*UserList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type UserSpec ¶
type UserSpec struct { ID string `json:"id"` Name string `json:"name"` AvatarURL string `json:"avatar_url"` AddedAt string `json:"added_at"` SSHKeys []SSHKeySpec `json:"ssh_keys"` }
UserSpec is the spec for a Containership Cloud user.
func (*UserSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserSpec.
func (*UserSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.