kube

Documentation

Overview

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• func BuildRestConfig(kubeconfig, context string) (*rest.Config, error)
• type ApisixRoute
  • func MustNewApisixRoute(obj interface{}) ApisixRoute
  • func NewApisixRoute(obj interface{}) (ApisixRoute, error)
• type ApisixRouteEvent
• type ApisixRouteInformer
• type ApisixRouteLister
  • func NewApisixRouteLister(v1 listersv1.ApisixRouteLister, v2alpha1 listersv2alpha1.ApisixRouteLister, ...) ApisixRouteLister
• type Endpoint
  • func NewEndpoint(ep *corev1.Endpoints) Endpoint
  • func NewEndpointWithSlice(ep *discoveryv1.EndpointSlice) Endpoint
• type EndpointLister
  • func NewEndpointListerAndInformer(factory informers.SharedInformerFactory, useEndpointSlice bool) (EndpointLister, cache.SharedIndexInformer)
• type HostPort
• type Ingress
  • func MustNewIngress(obj interface{}) Ingress
  • func NewIngress(obj interface{}) (Ingress, error)
• type IngressEvent
• type IngressInformer
• type IngressLister
  • func NewIngressLister(v1 listersnetworkingv1.IngressLister, ...) IngressLister
• type KubeClient
  • func NewKubeClient(cfg *config.Config) (*KubeClient, error)
  • func (k *KubeClient) NewAPISIXSharedIndexInformerFactory() externalversions.SharedInformerFactory
  • func (k *KubeClient) NewSharedIndexInformerFactory() informers.SharedInformerFactory

Constants

const (
	// ApisixRouteV1 represents the ApisixRoute in apisix.apache.org/v1 group version.
	ApisixRouteV1 = "apisix.apache.org/v1"
	// ApisixRouteV2alpha1 represents the ApisixRoute in apisix.apache.org/v2alpha1 group version
	ApisixRouteV2alpha1 = "apisix.apache.org/v2alpha1"
	// ApisixRouteV2beta1 represents the ApisixRoute in apisix.apache.org/v2beta1 group version
	ApisixRouteV2beta1 = "apisix.apache.org/v2beta1"
	// ApisixRouteV2beta2 represents the ApisixRoute in apisix.apache.org/v2beta2 group version
	ApisixRouteV2beta2 = "apisix.apache.org/v2beta2"
)

const (
	// IngressV1 represents the Ingress in networking/v1 group version.
	IngressV1 = "networking/v1"
	// IngressV1beta1 represents the Ingress in networking/v1beta1 group version.
	IngressV1beta1 = "networking/v1beta1"
	// IngressExtensionsV1beta1 represents the Ingress in extensions/v1beta1 group version.
	IngressExtensionsV1beta1 = "extensions/v1beta1"
)

Functions

func BuildRestConfig

func BuildRestConfig(kubeconfig, context string) (*rest.Config, error)

BuildRestConfig builds the rest.Config object from kubeconfig filepath and context, if kubeconfig is missing, building from in-cluster configuration.

Types

type ApisixRoute

type ApisixRoute interface {
	// GroupVersion returns the api group version of the
	// real ApisixRoute.
	GroupVersion() string
	// V1 returns the ApisixRoute in apisix.apache.org/v1, the real
	// ApisixRoute must be in this group version, otherwise will panic.
	V1() *configv1.ApisixRoute
	// V2alpha1 returns the ApisixRoute in apisix.apache.org/v2alpha1, the real
	// ApisixRoute must be in this group version, otherwise will panic.
	V2alpha1() *configv2alpha1.ApisixRoute
	// V2beta1 returns the ApisixRoute in apisix.apache.org/v2beta1, the real
	// ApisixRoute must be in this group version, otherwise will panic.
	V2beta1() *configv2beta1.ApisixRoute
	// V2beta2 returns the ApisixRoute in apisix.apache.org/v2beta2, the real
	// ApisixRoute must be in this group version, otherwise will panic.
	V2beta2() *configv2beta2.ApisixRoute
	// ResourceVersion returns the the resource version field inside
	// the real ApisixRoute.
	ResourceVersion() string
}

ApisixRoute is an encapsulation for ApisixRoute resource with different versions, for now, they are apisix.apache.org/v1 and apisix.apache.org/v2alpha1

func MustNewApisixRoute

func MustNewApisixRoute(obj interface{}) ApisixRoute

MustNewApisixRoute creates a kube.ApisixRoute object according to the type of obj.

func NewApisixRoute

func NewApisixRoute(obj interface{}) (ApisixRoute, error)

NewApisixRoute creates a kube.ApisixRoute object according to the type of obj. It returns nil and the error reason when the type assertion fails.

type ApisixRouteEvent

type ApisixRouteEvent struct {
	Key          string
	OldObject    ApisixRoute
	GroupVersion string
}

ApisixRouteEvent contains the ApisixRoute key (namespace/name) and the group version message.

type ApisixRouteInformer

type ApisixRouteInformer interface {
	Run(chan struct{})
}

ApisixRouteInformer is an encapsulation for the informer of ApisixRoute, it aims at to be compatible with different ApisixRoute versions.

type ApisixRouteLister

type ApisixRouteLister interface {
	// V1 gets the ApisixRoute in apisix.apache.org/v1.
	V1(string, string) (ApisixRoute, error)
	// V2alpha1 gets the ApisixRoute in apisix.apache.org/v2alpha1.
	V2alpha1(string, string) (ApisixRoute, error)
	// V2beta1 gets the ApisixRoute in apisix.apache.org/v2beta1.
	V2beta1(string, string) (ApisixRoute, error)
	// V2beta2 gets the ApisixRoute in apisix.apache.org/v2beta2.
	V2beta2(string, string) (ApisixRoute, error)
}

ApisixRouteLister is an encapsulation for the lister of ApisixRoute, it aims at to be compatible with different ApisixRoute versions.

func NewApisixRouteLister

func NewApisixRouteLister(v1 listersv1.ApisixRouteLister, v2alpha1 listersv2alpha1.ApisixRouteLister, v2beta1 listersv2beta1.ApisixRouteLister, v2beta2 listersv2beta2.ApisixRouteLister) ApisixRouteLister

type Endpoint

type Endpoint interface {
	// ServiceName returns the corresponding service owner of this endpoint.
	ServiceName() string
	// Namespace returns the residing namespace.
	Namespace() string
	// Endpoints returns the corresponding endpoints which matches the ServicePort.
	Endpoints(port *corev1.ServicePort) []HostPort
}

Endpoint is an encapsulation for the Kubernetes Endpoint and EndpointSlice objects.

func NewEndpoint

func NewEndpoint(ep *corev1.Endpoints) Endpoint

NewEndpoint creates an Endpoint which entity is Kubernetes Endpoints.

func NewEndpointWithSlice

func NewEndpointWithSlice(ep *discoveryv1.EndpointSlice) Endpoint

NewEndpointWithSlice creates an Endpoint which entity is Kubernetes EndpointSlices.

type EndpointLister

type EndpointLister interface {
	// GetEndpoint fetches an Endpoint which entity is the Kubernetes
	// Endpoint according to the namespace and name.
	GetEndpoint(string, string) (Endpoint, error)
	// GetEndpointSlices fetches an EndpointSlices which entity is the Kubernetes
	// EndpointSlice according to the namespace and service name label.
	GetEndpointSlices(string, string) (Endpoint, error)
}

EndpointLister is an encapsulation for the lister of Kubernetes Endpoint and EndpointSlice.

func NewEndpointListerAndInformer

func NewEndpointListerAndInformer(factory informers.SharedInformerFactory, useEndpointSlice bool) (EndpointLister, cache.SharedIndexInformer)

NewEndpointListerAndInformer creates an EndpointLister and the sharedIndexInformer.

type HostPort

type HostPort struct {
	Host string
	Port int
}

type Ingress

type Ingress interface {
	// GroupVersion returns the api group version of the
	// real ingress.
	GroupVersion() string
	// V1 returns the ingress in networking/v1, the real
	// ingress must be in networking/v1, or V1() will panic.
	V1() *networkingv1.Ingress
	// V1beta1 returns the ingress in networking/v1beta1, the real
	// ingress must be in networking/v1beta1, or V1beta1() will panic.
	V1beta1() *networkingv1beta1.Ingress
	// ExtensionsV1beta1 returns the ingress in extensions/v1beta1, the real
	// ingress must be in extensions/v1beta1, or ExtensionsV1beta1() will panic.
	ExtensionsV1beta1() *extensionsv1beta1.Ingress
	// ResourceVersion returns the the resource version field inside
	// the real Ingress.
	ResourceVersion() string
}

Ingress is an encapsulation for Kubernetes Ingress with different versions, for now, they are networking/v1 and networking/v1beta1.

func MustNewIngress

func MustNewIngress(obj interface{}) Ingress

MustNewIngress creates a kube.Ingress object according to the type of obj.

func NewIngress

func NewIngress(obj interface{}) (Ingress, error)

NewIngress creates a kube.Ingress object according to the type of obj. It returns nil and the error reason when the type assertion fails.

type IngressEvent

type IngressEvent struct {
	Key          string
	GroupVersion string
	OldObject    Ingress
}

IngressEvents contains the ingress key (namespace/name) and the group version message.

type IngressInformer

type IngressInformer interface {
	Run(chan struct{})
}

IngressInformer is an encapsulation for the informer of Kubernetes Ingress, it aims at to be compatible with different Ingress versions.

type IngressLister

type IngressLister interface {
	// V1 gets the ingress in networking/v1.
	V1(string, string) (Ingress, error)
	// V1beta1 gets the ingress in networking/v1beta1.
	V1beta1(string, string) (Ingress, error)
	// ExtensionsV1beta1 gets the ingress in extensions/v1beta1.
	ExtensionsV1beta1(string, string) (Ingress, error)
}

IngressLister is an encapsulation for the lister of Kubernetes Ingress, it aims at to be compatible with different Ingress versions.

func NewIngressLister

func NewIngressLister(v1 listersnetworkingv1.IngressLister, v1beta1 listersnetworkingv1beta1.IngressLister,
	extensionsv1beta1 listersextensionsv1beta1.IngressLister) IngressLister

NewIngressLister creates an version-neutral Ingress lister.

type KubeClient

type KubeClient struct {

	// Client is the object used to operate Kubernetes builtin resources.
	Client kubernetes.Interface
	// APISIXClient is the object used to operate resources under apisix.apache.org group.
	APISIXClient clientset.Interface
	// contains filtered or unexported fields
}

KubeClient contains some objects used to communicate with Kubernetes API Server.

func NewKubeClient

func NewKubeClient(cfg *config.Config) (*KubeClient, error)

NewKubeClient creates a high-level Kubernetes client.

func (*KubeClient) NewAPISIXSharedIndexInformerFactory

func (k *KubeClient) NewAPISIXSharedIndexInformerFactory() externalversions.SharedInformerFactory

NewAPISIXSharedIndexInformerFactory returns an index informer factory object used to watch and list Kubernetes resources in apisix.apache.org group.

func (*KubeClient) NewSharedIndexInformerFactory

func (k *KubeClient) NewSharedIndexInformerFactory() informers.SharedInformerFactory

NewSharedIndexInformerFactory returns an index informer factory object used to watch and list Kubernetes builtin resources.