Documentation
¶
Index ¶
- type AccessToken
- type AccessTokens
- type Account
- type Cluster
- type ClusterLabel
- type ClusterLabels
- type Clusters
- type CreateAccessTokenRequest
- type Error
- type IDResponse
- type Organization
- type Organizations
- type Plugin
- type PluginCatalog
- type PluginCompatibility
- type PluginDefinition
- type PluginKubernetesCompatibility
- type PluginPluginsCompatibility
- type PluginUpgradeRequest
- type PluginVersion
- type Plugins
- type Provider
- type Providers
- type Registries
- type Registry
- type SSHKey
- type SSHKeys
- type UUID
- type User
- type Users
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessToken ¶
type AccessToken struct {
// Timestamp at which the token was created
// Required: true
CreatedAt *string `json:"created_at"`
// Access token key ID
// Required: true
ID UUID `json:"id"`
// Name of the access token
// Required: true
Name *string `json:"name"`
// Access token value
Token string `json:"token,omitempty"`
// Timestamp at which the token was updated
// Required: true
UpdatedAt *string `json:"updated_at"`
// User ID of the associated user
// Required: true
UserID UUID `json:"user_id"`
}
AccessToken An access token belonging to a user swagger:model AccessToken
func (*AccessToken) MarshalBinary ¶
func (m *AccessToken) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AccessToken) UnmarshalBinary ¶
func (m *AccessToken) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AccessTokens ¶
type AccessTokens []*AccessToken
AccessTokens access tokens swagger:model AccessTokens
type Account ¶
type Account struct {
// Avatar URL associated with the account
// Required: true
AvatarURL *string `json:"avatar_url"`
// Timestamp at which the account was created
// Required: true
CreatedAt *string `json:"created_at"`
// Email associated with the account
// Required: true
Email *string `json:"email"`
// Flag indicating if the account is enabled
// Required: true
Enabled *bool `json:"enabled"`
// Account ID
// Required: true
ID UUID `json:"id"`
// User name
// Required: true
Name *string `json:"name"`
// Phone number associated with the account
// Required: true
Phone *string `json:"phone"`
// Timestamp at which the account was updated
// Required: true
UpdatedAt *string `json:"updated_at"`
}
Account A user account swagger:model Account
func (*Account) MarshalBinary ¶
MarshalBinary interface implementation
func (*Account) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Cluster ¶
type Cluster struct {
// API server address
// Required: true
APIServerAddress *string `json:"api_server_address"`
// Timestamp at which the cluster was created
// Required: true
CreatedAt *string `json:"created_at"`
// Cluster environment
// Required: true
Environment *string `json:"environment"`
// Cluster ID
// Required: true
ID UUID `json:"id"`
// Cluster name
// Required: true
Name *string `json:"name"`
// Organization ID of the organization the cluster belongs to
// Required: true
OrganizationID UUID `json:"organization_id"`
// Account ID of the cluster owner
// Required: true
OwnerID UUID `json:"owner_id"`
// Name of the provider through which the cluster is provisioned
// Required: true
ProviderName *string `json:"provider_name"`
// Timestamp at which the cluster was updated
// Required: true
UpdatedAt *string `json:"updated_at"`
// Kubernetes version
// Required: true
Version *string `json:"version"`
// Worker nodes address
// Required: true
WorkerNodesAddress *string `json:"worker_nodes_address"`
}
Cluster A cluster attached or provisioned through Containership swagger:model Cluster
func (*Cluster) MarshalBinary ¶
MarshalBinary interface implementation
func (*Cluster) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ClusterLabel ¶
type ClusterLabel struct {
// Timestamp at which the label was created
CreatedAt string `json:"created_at,omitempty"`
// Cluster label ID
ID UUID `json:"id,omitempty"`
// Label key
// Required: true
Key *string `json:"key"`
// Timestamp at which the label was updated
UpdatedAt string `json:"updated_at,omitempty"`
// Label value
// Required: true
Value *string `json:"value"`
}
ClusterLabel cluster label swagger:model ClusterLabel
func (*ClusterLabel) MarshalBinary ¶
func (m *ClusterLabel) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterLabel) UnmarshalBinary ¶
func (m *ClusterLabel) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterLabels ¶
type ClusterLabels []*ClusterLabel
ClusterLabels cluster labels swagger:model ClusterLabels
type CreateAccessTokenRequest ¶
type CreateAccessTokenRequest struct {
// Name of the access token
// Required: true
Name *string `json:"name"`
}
CreateAccessTokenRequest Request to create an access token swagger:model CreateAccessTokenRequest
func (*CreateAccessTokenRequest) MarshalBinary ¶
func (m *CreateAccessTokenRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateAccessTokenRequest) UnmarshalBinary ¶
func (m *CreateAccessTokenRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Error ¶
type Error struct {
// code
// Required: true
Code *int32 `json:"code"`
// message
// Required: true
Message *string `json:"message"`
}
Error error swagger:model Error
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type IDResponse ¶
type IDResponse struct {
// ID of some resource
// Required: true
ID UUID `json:"id"`
}
IDResponse ID response swagger:model IDResponse
func (*IDResponse) MarshalBinary ¶
func (m *IDResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IDResponse) UnmarshalBinary ¶
func (m *IDResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Organization ¶
type Organization struct {
// Timestamp at which the organization was created
// Required: true
CreatedAt *string `json:"created_at"`
// Organization ID
// Required: true
ID UUID `json:"id"`
// Flag indicating if the organization is locked
//
// If this flag is set to true, support must be contacted in order to re-enable access.
// Required: true
Locked *bool `json:"locked"`
// Name of the organization (typically a company name)
// Required: true
Name *string `json:"name"`
// User ID of the organization owner
// Required: true
OwnerID UUID `json:"owner_id"`
// Timestamp at which the organization was updated
// Required: true
UpdatedAt *string `json:"updated_at"`
}
Organization A Containership organization swagger:model Organization
func (*Organization) MarshalBinary ¶
func (m *Organization) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Organization) UnmarshalBinary ¶
func (m *Organization) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Organizations ¶
type Organizations []*Organization
Organizations organizations swagger:model Organizations
type Plugin ¶
type Plugin struct {
// Cluster ID
// Required: true
ClusterID *string `json:"cluster_id"`
// Plugin configuration (varies per-plugin)
// Required: true
Configuration interface{} `json:"configuration"`
// Timestamp at which the plugin was created
// Required: true
CreatedAt *string `json:"created_at"`
// Plugin ID
// Required: true
ID UUID `json:"id"`
// Plugin implementation, e.g. prometheus
// Required: true
Implementation *string `json:"implementation"`
// Organization ID
// Required: true
OrganizationID *string `json:"organization_id"`
// Plugin type, e.g. metrics
// Required: true
Type *string `json:"type"`
// Timestamp at which the plugin was updated
// Required: true
UpdatedAt *string `json:"updated_at"`
// Plugin version
// Required: true
Version *string `json:"version"`
}
Plugin A Containership plugin swagger:model Plugin
func (*Plugin) MarshalBinary ¶
MarshalBinary interface implementation
func (*Plugin) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PluginCatalog ¶
type PluginCatalog struct {
// Container Network Interface (CNI) Plugins
CNI []*PluginDefinition `json:"CNI,omitempty"`
// Container Storage Interface (CSI) Plugins
CSI []*PluginDefinition `json:"CSI,omitempty"`
// Autoscaler Plugins
Autoscaler []*PluginDefinition `json:"autoscaler,omitempty"`
// Cloud Controller Manager Plugins
CloudControllerManager []*PluginDefinition `json:"cloud_controller_manager,omitempty"`
// Cluster Management Plugins
ClusterManagement []*PluginDefinition `json:"cluster_management,omitempty"`
// Log Plugins
Logs []*PluginDefinition `json:"logs,omitempty"`
// Metric Plugins
Metrics []*PluginDefinition `json:"metrics,omitempty"`
}
PluginCatalog A Containership plugin definition swagger:model PluginCatalog
func (*PluginCatalog) MarshalBinary ¶
func (m *PluginCatalog) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginCatalog) UnmarshalBinary ¶
func (m *PluginCatalog) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginCompatibility ¶
type PluginCompatibility struct {
// The definition for Kubernetes compatibility
// Required: true
Kubernetes *PluginKubernetesCompatibility `json:"kubernetes"`
// The plugins required and version compatibility for this plugin
Plugins map[string]PluginPluginsCompatibility `json:"plugins,omitempty"`
// The list of valid upgrade paths for the plugin
// Required: true
Upgrades []string `json:"upgrades"`
}
PluginCompatibility A Containership plugin compatibility definition swagger:model PluginCompatibility
func (*PluginCompatibility) MarshalBinary ¶
func (m *PluginCompatibility) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginCompatibility) UnmarshalBinary ¶
func (m *PluginCompatibility) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginDefinition ¶
type PluginDefinition struct {
// The implementation of the type of plugin
// Required: true
Implementation *string `json:"implementation"`
// The type of plugin
// Required: true
Type *string `json:"type"`
// The version compatibility definition
// Required: true
Versions []*PluginVersion `json:"versions"`
}
PluginDefinition A Containership plugin definition swagger:model PluginDefinition
func (*PluginDefinition) MarshalBinary ¶
func (m *PluginDefinition) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginDefinition) UnmarshalBinary ¶
func (m *PluginDefinition) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginKubernetesCompatibility ¶
type PluginKubernetesCompatibility struct {
// The maximum Kubernetes version for the plugin
// Required: true
Max *string `json:"max"`
// The minimum Kubernetes version for the plugin
// Required: true
Min *string `json:"min"`
}
PluginKubernetesCompatibility Defines the Kubernetes version that the plugin supports swagger:model PluginKubernetesCompatibility
func (*PluginKubernetesCompatibility) MarshalBinary ¶
func (m *PluginKubernetesCompatibility) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginKubernetesCompatibility) UnmarshalBinary ¶
func (m *PluginKubernetesCompatibility) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginPluginsCompatibility ¶
type PluginPluginsCompatibility struct {
// The implementation name for the type of plugin
// Required: true
Implementation *string `json:"implementation"`
// The maximum plugin version
// Required: true
Max *string `json:"max"`
// The minimum plugin version
// Required: true
Min *string `json:"min"`
}
PluginPluginsCompatibility Defines the Plugin required and what versions are compatible with this version of the parent plugin swagger:model PluginPluginsCompatibility
func (*PluginPluginsCompatibility) MarshalBinary ¶
func (m *PluginPluginsCompatibility) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginPluginsCompatibility) UnmarshalBinary ¶
func (m *PluginPluginsCompatibility) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginUpgradeRequest ¶
type PluginUpgradeRequest struct {
// Version to upgrade to
// Required: true
Version *string `json:"version"`
}
PluginUpgradeRequest Upgrade a plugin swagger:model PluginUpgradeRequest
func (*PluginUpgradeRequest) MarshalBinary ¶
func (m *PluginUpgradeRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginUpgradeRequest) UnmarshalBinary ¶
func (m *PluginUpgradeRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginVersion ¶
type PluginVersion struct {
// Kubernetes and upgrade compatibility
// Required: true
Compatibility *PluginCompatibility `json:"compatibility"`
// Required configuration keys
// Required: true
ConfigurationSchema []string `json:"configuration_schema"`
// If the plugin is disabled
Disabled bool `json:"disabled,omitempty"`
// The plugin version
// Required: true
Version *string `json:"version"`
}
PluginVersion A Containership plugin version definition swagger:model PluginVersion
func (*PluginVersion) MarshalBinary ¶
func (m *PluginVersion) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginVersion) UnmarshalBinary ¶
func (m *PluginVersion) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Provider ¶
type Provider struct {
// Timestamp at which the provider was created
// Required: true
CreatedAt *string `json:"created_at"`
// Provider description
// Required: true
Description *string `json:"description"`
// Provider ID
// Required: true
ID UUID `json:"id"`
// Organization ID of the organization the provider belongs to
// Required: true
OrganizationID UUID `json:"organization_id"`
// Provider name
// Required: true
Provider *string `json:"provider"`
// Timestamp at which the provider was updated
// Required: true
UpdatedAt *string `json:"updated_at"`
}
Provider A set of cloud provider credentials swagger:model Provider
func (*Provider) MarshalBinary ¶
MarshalBinary interface implementation
func (*Provider) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Registry ¶
type Registry struct {
// Timestamp at which the registry was added
// Required: true
CreatedAt *string `json:"created_at"`
// Registry credentials
Credentials interface{} `json:"credentials,omitempty"`
// Registry description
// Required: true
Description *string `json:"description"`
// Registry ID
// Required: true
ID UUID `json:"id"`
// Organization ID
// Required: true
OrganizationID *string `json:"organization_id"`
// Registry provider, e.g. quay or dockerhub
// Required: true
Provider *string `json:"provider"`
// Registry server address
// Required: true
Serveraddress *string `json:"serveraddress"`
// Timestamp at which the registry was updated
// Required: true
UpdatedAt *string `json:"updated_at"`
}
Registry A Containership registry swagger:model Registry
func (*Registry) MarshalBinary ¶
MarshalBinary interface implementation
func (*Registry) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SSHKey ¶
type SSHKey struct {
// Timestamp at which the key was created
// Required: true
CreatedAt *string `json:"created_at"`
// Fingerprint of the key
// Required: true
Fingerprint *string `json:"fingerprint"`
// SSH key ID
// Required: true
ID UUID `json:"id"`
// Public key
// Required: true
Key *string `json:"key"`
// Name of the key
// Required: true
Name *string `json:"name"`
// Timestamp at which the key was updated
// Required: true
UpdatedAt *string `json:"updated_at"`
// User ID of the associated user
// Required: true
UserID UUID `json:"user_id"`
}
SSHKey An SSH key belonging to a user swagger:model SSHKey
func (*SSHKey) MarshalBinary ¶
MarshalBinary interface implementation
func (*SSHKey) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type User ¶
type User struct {
// Timestamp at which the user was created
// Required: true
AddedAt *string `json:"added_at"`
// Avatar URL
// Required: true
AvatarURL *string `json:"avatar_url"`
// User email
// Required: true
Email *string `json:"email"`
// User ID
// Required: true
ID UUID `json:"id"`
// User name
// Required: true
Name *string `json:"name"`
// SSH Keys
// Required: true
SSHKeys SSHKeys `json:"ssh_keys"`
}
User A user belonging to an organization swagger:model User
func (*User) MarshalBinary ¶
MarshalBinary interface implementation
func (*User) UnmarshalBinary ¶
UnmarshalBinary interface implementation
Source Files
¶
- access_token.go
- access_tokens.go
- account.go
- cluster.go
- cluster_label.go
- cluster_labels.go
- clusters.go
- create_access_token_request.go
- error.go
- id_response.go
- organization.go
- organizations.go
- plugin.go
- plugin_catalog.go
- plugin_compatibility.go
- plugin_definition.go
- plugin_kubernetes_compatibility.go
- plugin_plugins_compatibility.go
- plugin_upgrade_request.go
- plugin_version.go
- plugins.go
- provider.go
- providers.go
- registries.go
- registry.go
- ssh_key.go
- ssh_keys.go
- user.go
- users.go
- uuid.go