Documentation ¶
Overview ¶
Package v2 is the v2 version of the API. +groupName=kanali.io
Index ¶
- Variables
- func Resource(resource string) schema.GroupResource
- type ApiKey
- type ApiKeyBinding
- type ApiKeyBindingList
- type ApiKeyBindingSpec
- type ApiKeyList
- type ApiKeySpec
- type ApiProxy
- type ApiProxyList
- type ApiProxySpec
- type Backend
- type GranularProxy
- type Key
- type Label
- type Mock
- type MockTarget
- type MockTargetList
- type MockTargetSpec
- type Path
- type Plugin
- type Rate
- type Revision
- type RevisionStatus
- type Route
- type Rule
- type SSL
- type Service
- type Source
- type Target
Constants ¶
This section is empty.
Variables ¶
var ( // localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes. SchemeBuilder runtime.SchemeBuilder AddToScheme = localSchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: kanaliio.GroupName, Version: "v2"}
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 ApiKey ¶
type ApiKey struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec ApiKeySpec `json:"spec"` }
ApiKey describes an ApiKey
func (*ApiKey) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApiKey.
func (*ApiKey) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ApiKey) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ApiKeyBinding ¶
type ApiKeyBinding struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec ApiKeyBindingSpec `json:"spec"` }
ApiKeyBinding describes an ApiKeyBinding
func (*ApiKeyBinding) DeepCopy ¶
func (in *ApiKeyBinding) DeepCopy() *ApiKeyBinding
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApiKeyBinding.
func (*ApiKeyBinding) DeepCopyInto ¶
func (in *ApiKeyBinding) DeepCopyInto(out *ApiKeyBinding)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ApiKeyBinding) DeepCopyObject ¶
func (in *ApiKeyBinding) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ApiKeyBindingList ¶
type ApiKeyBindingList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []ApiKeyBinding `json:"items"` }
ApiKeyBindingList represents a list of ApiKeyBinding resources
func (*ApiKeyBindingList) DeepCopy ¶
func (in *ApiKeyBindingList) DeepCopy() *ApiKeyBindingList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApiKeyBindingList.
func (*ApiKeyBindingList) DeepCopyInto ¶
func (in *ApiKeyBindingList) DeepCopyInto(out *ApiKeyBindingList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ApiKeyBindingList) DeepCopyObject ¶
func (in *ApiKeyBindingList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ApiKeyBindingSpec ¶
type ApiKeyBindingSpec struct {
Keys []Key `json:"keys"`
}
ApiKeyBindingSpec is the spec for an ApiKeyBinding
func (*ApiKeyBindingSpec) DeepCopy ¶
func (in *ApiKeyBindingSpec) DeepCopy() *ApiKeyBindingSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApiKeyBindingSpec.
func (*ApiKeyBindingSpec) DeepCopyInto ¶
func (in *ApiKeyBindingSpec) DeepCopyInto(out *ApiKeyBindingSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ApiKeyList ¶
type ApiKeyList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []ApiKey `json:"items"` }
ApiKeyList is a list of ApiKey resources
func (*ApiKeyList) DeepCopy ¶
func (in *ApiKeyList) DeepCopy() *ApiKeyList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApiKeyList.
func (*ApiKeyList) DeepCopyInto ¶
func (in *ApiKeyList) DeepCopyInto(out *ApiKeyList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ApiKeyList) DeepCopyObject ¶
func (in *ApiKeyList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ApiKeySpec ¶
type ApiKeySpec struct {
Revisions []Revision `json:"revisions"`
}
APIKeySpec is the spec for an ApiKey
func (*ApiKeySpec) DeepCopy ¶
func (in *ApiKeySpec) DeepCopy() *ApiKeySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApiKeySpec.
func (*ApiKeySpec) DeepCopyInto ¶
func (in *ApiKeySpec) DeepCopyInto(out *ApiKeySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ApiProxy ¶
type ApiProxy struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec ApiProxySpec `json:"spec"` }
ApiProxy describe an ApiProxy
func (*ApiProxy) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApiProxy.
func (*ApiProxy) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ApiProxy) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ApiProxyList ¶
type ApiProxyList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []ApiProxy `json:"items"` }
ApiProxyList is a list of ApiProxy resources
func (*ApiProxyList) DeepCopy ¶
func (in *ApiProxyList) DeepCopy() *ApiProxyList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApiProxyList.
func (*ApiProxyList) DeepCopyInto ¶
func (in *ApiProxyList) DeepCopyInto(out *ApiProxyList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ApiProxyList) DeepCopyObject ¶
func (in *ApiProxyList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ApiProxySpec ¶
type ApiProxySpec struct { Source Source `json:"source"` Target Target `json:"target"` Plugins []Plugin `json:"plugins,omitempty"` }
ApiProxySpec is the spec for an ApiProxy
func (*ApiProxySpec) DeepCopy ¶
func (in *ApiProxySpec) DeepCopy() *ApiProxySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ApiProxySpec.
func (*ApiProxySpec) DeepCopyInto ¶
func (in *ApiProxySpec) DeepCopyInto(out *ApiProxySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Backend ¶
type Backend struct { Endpoint *string `json:"endpoint,omitempty"` Mock *Mock `json:"mock,omitempty"` Service *Service `json:"service,omitempty"` }
Backend describes an upstream server
func (*Backend) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Backend.
func (*Backend) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GranularProxy ¶
type GranularProxy struct {
Verbs []string `json:"verbs"`
}
GranularProxy defines a list of authorized HTTP verbs
func (*GranularProxy) DeepCopy ¶
func (in *GranularProxy) DeepCopy() *GranularProxy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GranularProxy.
func (*GranularProxy) DeepCopyInto ¶
func (in *GranularProxy) DeepCopyInto(out *GranularProxy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Key ¶
type Key struct { Name string `json:"name"` Rate Rate `json:"rate,omitempty"` DefaultRule Rule `json:"defaultRule,omitempty"` Subpaths []Path `json:"subpaths,omitempty"` }
Key defines a unique key with permissions
func (*Key) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Key.
func (*Key) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Label ¶
type Label struct { Name string `json:"name"` Header string `json:"header,omitempty"` Value string `json:"value,omitempty"` }
Label defines a unique label to be matched against service metadata
func (*Label) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Label.
func (*Label) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Mock ¶
type Mock struct {
MockTargetName string `json:"mockTargetName"`
}
Mock describes a valid mock response
func (*Mock) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Mock.
func (*Mock) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MockTarget ¶
type MockTarget struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec MockTargetSpec `json:"spec"` }
MockTarget describes a MockTarget
func (*MockTarget) DeepCopy ¶
func (in *MockTarget) DeepCopy() *MockTarget
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MockTarget.
func (*MockTarget) DeepCopyInto ¶
func (in *MockTarget) DeepCopyInto(out *MockTarget)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MockTarget) DeepCopyObject ¶
func (in *MockTarget) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MockTargetList ¶
type MockTargetList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []MockTarget `json:"items"` }
MockTargetList is a list of MockTarget resources
func (*MockTargetList) DeepCopy ¶
func (in *MockTargetList) DeepCopy() *MockTargetList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MockTargetList.
func (*MockTargetList) DeepCopyInto ¶
func (in *MockTargetList) DeepCopyInto(out *MockTargetList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MockTargetList) DeepCopyObject ¶
func (in *MockTargetList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MockTargetSpec ¶
type MockTargetSpec struct {
Routes []Route `json:"routes"`
}
MockTargetSpec is the spec for a MockTarget
func (*MockTargetSpec) DeepCopy ¶
func (in *MockTargetSpec) DeepCopy() *MockTargetSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MockTargetSpec.
func (*MockTargetSpec) DeepCopyInto ¶
func (in *MockTargetSpec) DeepCopyInto(out *MockTargetSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Path ¶
Path describes a subpath with unique permissions
func (*Path) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Path.
func (*Path) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Plugin ¶
type Plugin struct { Name string `json:"name"` Version string `json:"version,omitempty"` Config map[string]string `json:"config,omitempty"` }
Plugin describes a unique plugin to be envoked
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.
type Rate ¶
Rate defines rate limit rule
func (*Rate) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Rate.
func (*Rate) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Revision ¶
type Revision struct { Data string `json:"data"` Status RevisionStatus `json:"status"` LastUsed string `json:"lastUsed"` }
ApiKeyRevision is an ApiKey revision
func (*Revision) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Revision.
func (*Revision) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RevisionStatus ¶
type RevisionStatus string
const ( RevisionStatusActive RevisionStatus = "Active" RevisionStatusInactive RevisionStatus = "Inactive" )
type Route ¶
type Route struct { Path string `json:"path"` StatusCode int `json:"status"` Methods []string `json:"methods,omitempty"` Headers map[string]string `json:"headers,omitempty"` Body []byte `json:"body"` }
Route defines the behavior of an http request for a unique route
func (*Route) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Route.
func (*Route) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Rule ¶
type Rule struct { Global bool `json:"global,omitempty"` Granular GranularProxy `json:"granular,omitempty"` }
Rule defines a single permission
func (*Rule) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Rule.
func (*Rule) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SSL ¶
type SSL struct {
SecretName string `json:"secretName"`
}
SSL describes the anoatomy of a backend TLS connection
func (*SSL) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SSL.
func (*SSL) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Service ¶
type Service struct { Name string `json:"name,omitempty"` Port int64 `json:"port"` Labels []Label `json:"labels,omitempty"` }
Service describes a Kubernetes service
func (*Service) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Service.
func (*Service) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Source ¶
Source represents an incoming request
func (*Source) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Source.
func (*Source) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Target ¶
type Target struct { Path string `json:"path,omitempty"` Backend Backend `json:"backend,omitempty"` SSL *SSL `json:"ssl,omitempty"` }
Target describes a target proxy
func (*Target) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Target.
func (*Target) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.