Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the config v1alpha1 API group
Index ¶
Constants ¶
const GroupName = "config.apoxy.dev"
GroupName specifies the group name used to register the objects.
Variables ¶
var ( // localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes. SchemeBuilder runtime.SchemeBuilder // Deprecated: use Install instead AddToScheme = localSchemeBuilder.AddToScheme Install = localSchemeBuilder.AddToScheme )
var GroupVersion = v1.GroupVersion{Group: GroupName, Version: "v1alpha1"}
GroupVersion specifies the group and the version used to register the objects.
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}
SchemeGroupVersion is group version used to register these objects Deprecated: use GroupVersion instead.
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type Config ¶
type Config struct {
metav1.TypeMeta `json:",inline"`
// The name of this instance, if not specified the hostname of the machine
// will be used.
Name string `json:"name,omitempty"`
// Whether to enable verbose logging.
Verbose bool `json:"verbose,omitempty"`
// The URL for the dashboard UI.
DashboardURL string `json:"dashboardURL,omitempty"`
// CurrentProject is the default project ID to use unless overridden.
CurrentProject uuid.UUID `json:"currentProject,omitempty"`
// Projects is a list of projects that this instance is managing.
Projects []Project `json:"projects,omitempty"`
// Tunnel is the configuration for the tunnel.
Tunnel *TunnelConfig `json:"tunnel,omitempty"`
}
Config is the Schema for the Apoxy Backplane configuration.
func (*Config) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Config.
func (*Config) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Config) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type Project ¶
type Project struct {
// ID is the project ID.
ID uuid.UUID `json:"id"`
// The base URL for API requests.
APIBaseURL string `json:"apiBaseURL,omitempty"`
// The host header to set for API requests.
APIBaseHost string `json:"apiBaseHost,omitempty"`
// APIKey is the API key for the project.
APIKey string `json:"apiKey"`
}
Project is a configuration for a project.
func (*Project) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Project.
func (*Project) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TunnelConfig ¶ added in v0.4.2
type TunnelConfig struct {
// Mode is the mode of the tunnel.
Mode TunnelMode `json:"mode,omitempty"`
// SocksPort, when running in userspace mode, is the port to listen on for
// SOCKS5 proxy connections. If not specified it will default to 1080.
SocksPort *int `json:"socksPort,omitempty"`
// STUNServers is an optional list of STUN servers to use for determining the
// external address of the tunnel node. If not specified it will default to
// Google and Cloudflare's public STUN servers.
STUNServers []string `json:"stunServers,omitempty"`
}
TunnelConfig is the configuration for the tunnel.
func (*TunnelConfig) DeepCopy ¶ added in v0.4.2
func (in *TunnelConfig) DeepCopy() *TunnelConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TunnelConfig.
func (*TunnelConfig) DeepCopyInto ¶ added in v0.4.2
func (in *TunnelConfig) DeepCopyInto(out *TunnelConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TunnelMode ¶ added in v0.4.2
type TunnelMode string
TunnelMode is the mode of the tunnel.
const ( // Use the kernel implementation of WireGuard. TunnelModeKernel TunnelMode = "kernel" // Use an unprivileged userspace implementation of WireGuard. TunnelModeUserspace TunnelMode = "userspace" )
Source Files