Documentation
¶
Overview ¶
Package v1 is the v1 version of the configuration.konghq.com API. +groupName=configuration.konghq.com
Index ¶
- Variables
- func Resource(resource string) schema.GroupResource
- type ConfigSource
- type KongClusterPlugin
- type KongClusterPluginList
- type KongConsumer
- type KongConsumerList
- type KongIngress
- type KongIngressList
- type KongPlugin
- type KongPluginList
- type NamespacedConfigSource
- type NamespacedSecretValueFromSource
- type SecretValueFromSource
Constants ¶
This section is empty.
Variables ¶
var ( // SchemeBuilder is a schemeBuilder with all CRDs SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) // AddToScheme points to SchemeBuilder's AddToScheme AddToScheme = SchemeBuilder.AddToScheme // SchemeGroupVersion is API Group and Version of // Kong Ingress Controller's API. SchemeGroupVersion = schema.GroupVersion{Group: "configuration.konghq.com", Version: "v1"} )
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type ConfigSource ¶
type ConfigSource struct {
metav1.TypeMeta `json:",inline"`
SecretValue SecretValueFromSource `json:"secretKeyRef,omitempty"`
}
ConfigSource is a wrapper around SecretValueFromSource +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*ConfigSource) DeepCopy ¶
func (in *ConfigSource) DeepCopy() *ConfigSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConfigSource.
func (*ConfigSource) DeepCopyInto ¶
func (in *ConfigSource) DeepCopyInto(out *ConfigSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ConfigSource) DeepCopyObject ¶
func (in *ConfigSource) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KongClusterPlugin ¶
type KongClusterPlugin struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ObjectMeta `json:"metadata,omitempty"`
// ConsumerRef is a reference to a particular consumer
ConsumerRef string `json:"consumerRef,omitempty"`
// Disabled set if the plugin is disabled or not
Disabled bool `json:"disabled,omitempty"`
// Config contains the plugin configuration.
Config apiextensionsv1.JSON `json:"config,omitempty"`
// ConfigFrom references a secret containing the plugin configuration.
ConfigFrom NamespacedConfigSource `json:"configFrom,omitempty"`
// PluginName is the name of the plugin to which to apply the config
PluginName string `json:"plugin,omitempty"`
// RunOn configures the plugin to run on the first or the second or both
// nodes in case of a service mesh deployment.
RunOn string `json:"run_on,omitempty"`
// Protocols configures plugin to run on requests received on specific
// protocols.
Protocols []string `json:"protocols,omitempty"`
}
KongClusterPlugin is a top-level type. A client is created for it. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*KongClusterPlugin) DeepCopy ¶
func (in *KongClusterPlugin) DeepCopy() *KongClusterPlugin
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KongClusterPlugin.
func (*KongClusterPlugin) DeepCopyInto ¶
func (in *KongClusterPlugin) DeepCopyInto(out *KongClusterPlugin)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KongClusterPlugin) DeepCopyObject ¶
func (in *KongClusterPlugin) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KongClusterPluginList ¶
type KongClusterPluginList struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ListMeta `json:"metadata,omitempty"`
// +optional
Items []KongClusterPlugin `json:"items"`
}
KongClusterPluginList is a top-level list type. The client methods for lists are automatically created. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*KongClusterPluginList) DeepCopy ¶
func (in *KongClusterPluginList) DeepCopy() *KongClusterPluginList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KongClusterPluginList.
func (*KongClusterPluginList) DeepCopyInto ¶
func (in *KongClusterPluginList) DeepCopyInto(out *KongClusterPluginList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KongClusterPluginList) DeepCopyObject ¶
func (in *KongClusterPluginList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KongConsumer ¶
type KongConsumer struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ObjectMeta `json:"metadata,omitempty"`
// Username unique username of the consumer.
Username string `json:"username,omitempty"`
// CustomID existing unique ID for the consumer - useful for mapping
// Kong with users in your existing database
CustomID string `json:"custom_id,omitempty"`
// Credentials are references to secrets containing a credential to be
// provisioned in Kong.
Credentials []string `json:"credentials,omitempty"`
}
KongConsumer is a top-level type. A client is created for it. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*KongConsumer) DeepCopy ¶
func (in *KongConsumer) DeepCopy() *KongConsumer
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KongConsumer.
func (*KongConsumer) DeepCopyInto ¶
func (in *KongConsumer) DeepCopyInto(out *KongConsumer)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KongConsumer) DeepCopyObject ¶
func (in *KongConsumer) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KongConsumerList ¶
type KongConsumerList struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ListMeta `json:"metadata,omitempty"`
// +optional
Items []KongConsumer `json:"items"`
}
KongConsumerList is a top-level list type. The client methods for lists are automatically created. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*KongConsumerList) DeepCopy ¶
func (in *KongConsumerList) DeepCopy() *KongConsumerList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KongConsumerList.
func (*KongConsumerList) DeepCopyInto ¶
func (in *KongConsumerList) DeepCopyInto(out *KongConsumerList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KongConsumerList) DeepCopyObject ¶
func (in *KongConsumerList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KongIngress ¶
type KongIngress struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ObjectMeta `json:"metadata,omitempty"`
Upstream *kong.Upstream `json:"upstream,omitempty"`
Proxy *kong.Service `json:"proxy,omitempty"`
Route *kong.Route `json:"route,omitempty"`
}
KongIngress is a top-level type. A client is created for it. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*KongIngress) DeepCopy ¶
func (in *KongIngress) DeepCopy() *KongIngress
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KongIngress.
func (*KongIngress) DeepCopyInto ¶
func (in *KongIngress) DeepCopyInto(out *KongIngress)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KongIngress) DeepCopyObject ¶
func (in *KongIngress) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KongIngressList ¶
type KongIngressList struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ListMeta `json:"metadata,omitempty"`
// +optional
Items []KongIngress `json:"items"`
}
KongIngressList is a top-level list type. The client methods for lists are automatically created. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*KongIngressList) DeepCopy ¶
func (in *KongIngressList) DeepCopy() *KongIngressList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KongIngressList.
func (*KongIngressList) DeepCopyInto ¶
func (in *KongIngressList) DeepCopyInto(out *KongIngressList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KongIngressList) DeepCopyObject ¶
func (in *KongIngressList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KongPlugin ¶
type KongPlugin struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ObjectMeta `json:"metadata,omitempty"`
// ConsumerRef is a reference to a particular consumer
ConsumerRef string `json:"consumerRef,omitempty"`
// Disabled set if the plugin is disabled or not
Disabled bool `json:"disabled,omitempty"`
// Config contains the plugin configuration.
Config apiextensionsv1.JSON `json:"config,omitempty"`
// ConfigFrom references a secret containing the plugin configuration.
ConfigFrom ConfigSource `json:"configFrom,omitempty"`
// PluginName is the name of the plugin to which to apply the config
PluginName string `json:"plugin,omitempty"`
// RunOn configures the plugin to run on the first or the second or both
// nodes in case of a service mesh deployment.
RunOn string `json:"run_on,omitempty"`
// Protocols configures plugin to run on requests received on specific
// protocols.
Protocols []string `json:"protocols,omitempty"`
}
KongPlugin is a top-level type. A client is created for it. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*KongPlugin) DeepCopy ¶
func (in *KongPlugin) DeepCopy() *KongPlugin
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KongPlugin.
func (*KongPlugin) DeepCopyInto ¶
func (in *KongPlugin) DeepCopyInto(out *KongPlugin)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KongPlugin) DeepCopyObject ¶
func (in *KongPlugin) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KongPluginList ¶
type KongPluginList struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ListMeta `json:"metadata,omitempty"`
// +optional
Items []KongPlugin `json:"items"`
}
KongPluginList is a top-level list type. The client methods for lists are automatically created. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*KongPluginList) DeepCopy ¶
func (in *KongPluginList) DeepCopy() *KongPluginList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KongPluginList.
func (*KongPluginList) DeepCopyInto ¶
func (in *KongPluginList) DeepCopyInto(out *KongPluginList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KongPluginList) DeepCopyObject ¶
func (in *KongPluginList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NamespacedConfigSource ¶
type NamespacedConfigSource struct {
metav1.TypeMeta `json:",inline"`
SecretValue NamespacedSecretValueFromSource `json:"secretKeyRef,omitempty"`
}
NamespacedConfigSource is a wrapper around NamespacedSecretValueFromSource +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*NamespacedConfigSource) DeepCopy ¶
func (in *NamespacedConfigSource) DeepCopy() *NamespacedConfigSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NamespacedConfigSource.
func (*NamespacedConfigSource) DeepCopyInto ¶
func (in *NamespacedConfigSource) DeepCopyInto(out *NamespacedConfigSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NamespacedConfigSource) DeepCopyObject ¶
func (in *NamespacedConfigSource) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type NamespacedSecretValueFromSource ¶
type NamespacedSecretValueFromSource struct {
metav1.TypeMeta `json:",inline"`
// The namespace containing the secret
Namespace string `json:"namespace,omitempty"`
// the secret containing the key
Secret string `json:"name,omitempty"`
// the key containing the value
Key string `json:"key,omitempty"`
}
NamespacedSecretValueFromSource represents the source of a secret value, specifying the secret namespace +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*NamespacedSecretValueFromSource) DeepCopy ¶
func (in *NamespacedSecretValueFromSource) DeepCopy() *NamespacedSecretValueFromSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NamespacedSecretValueFromSource.
func (*NamespacedSecretValueFromSource) DeepCopyInto ¶
func (in *NamespacedSecretValueFromSource) DeepCopyInto(out *NamespacedSecretValueFromSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*NamespacedSecretValueFromSource) DeepCopyObject ¶
func (in *NamespacedSecretValueFromSource) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SecretValueFromSource ¶
type SecretValueFromSource struct {
metav1.TypeMeta `json:",inline"`
// the secret containing the key
Secret string `json:"name,omitempty"`
// the key containing the value
Key string `json:"key,omitempty"`
}
SecretValueFromSource represents the source of a secret value +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
func (*SecretValueFromSource) DeepCopy ¶
func (in *SecretValueFromSource) DeepCopy() *SecretValueFromSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretValueFromSource.
func (*SecretValueFromSource) DeepCopyInto ¶
func (in *SecretValueFromSource) DeepCopyInto(out *SecretValueFromSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*SecretValueFromSource) DeepCopyObject ¶
func (in *SecretValueFromSource) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.