kubernetes

Documentation

Overview

Copyright © 2019 Portworx

Licensed 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.

Copyright © 2019 Portworx

Licensed 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.

Copyright © 2019 Portworx

Licensed 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.

Copyright © 2019 Portworx

Licensed 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
• Variables
• func KubeConnect(cfgFile, context string) (clientcmd.ClientConfig, *kubernetes.Clientset, error)
• func KubeConnectDefault() (clientcmd.ClientConfig, *kubernetes.Clientset, error)
• type COps
  • func NewCOps(kc *KubeConnectionData) COps
• type COpsLogOptions
• type ContainerInfo
• type KubeConnectionData
  • func (p *KubeConnectionData) GetLogs(lo *COpsLogOptions, out io.Writer) error
  • func (p *KubeConnectionData) GetPodsByLabels(namespace string, labels string) ([]v1.Pod, error)
  • func (p *KubeConnectionData) GetPvcsByLabels(namespace string, labels string) ([]v1.PersistentVolumeClaim, error)
• type PxPvc
  • func NewPxPvc(pvc *v1.PersistentVolumeClaim) *PxPvc
  • func (p *PxPvc) GetPodNames() []string
  • func (p *PxPvc) GetVolume() *api.Volume
  • func (p *PxPvc) SetPods(pods []v1.Pod) bool
  • func (p *PxPvc) SetVolume(responses []*api.SdkVolumeInspectResponse) bool

Constants

const (
	DEFAULT_TAIL_LINES = int64(10)
	NO_TAIL_LINES      = int64(-1)
)

Variables

var (
	NODE_KEY = []byte("node=")
)

Functions

func KubeConnect

func KubeConnect(cfgFile, context string) (clientcmd.ClientConfig, *kubernetes.Clientset, error)

KubeConnect will return a Kubernetes client using the kubeconfig file set in the default context. clientcmd.ClientConfig will allow the caller to call ClientConfig.Namespace() to get the namespace set by the caller on their Kubeconfig.

func KubeConnectDefault

func KubeConnectDefault() (clientcmd.ClientConfig, *kubernetes.Clientset, error)

KubeConnectDefault returns a Kubernetes client to the default or named context.

Types

type COps

type COps interface {
	// GetPodsByLabels returns pods from specified namespace with the given labels
	// labels should be of the form "abc=def,xyz=mno"
	GetPodsByLabels(namespace string, labels string) ([]v1.Pod, error)
	// GetPvcsByLabels returns pvcs from spacified namespace with given labels
	// labels should be of the form "abc=def,xyz=mno"
	GetPvcsByLabels(namespace string, labels string) ([]v1.PersistentVolumeClaim, error)
	// GetLogs writes out logs to out based on the logOptions specified
	GetLogs(logOptions *COpsLogOptions, out io.Writer) error
}

func NewCOps

func NewCOps(kc *KubeConnectionData) COps

type COpsLogOptions

type COpsLogOptions struct {
	PodLogOptions       v1.PodLogOptions
	IgnoreLogErrors     bool
	MaxFollowConcurency int
	ShowPodInfo         bool
	Filters             []string
	ApplyFilters        bool
	PortworxNamespace   string
	CInfo               []ContainerInfo
}

type ContainerInfo

type ContainerInfo struct {
	Pod       v1.Pod
	Container string
	MountPath string
}

type KubeConnectionData

type KubeConnectionData struct {
	ClientConfig clientcmd.ClientConfig
	ClientSet    *kclikube.Clientset
}

func (*KubeConnectionData) GetLogs

func (p *KubeConnectionData) GetLogs(
	lo *COpsLogOptions,
	out io.Writer,
) error

func (*KubeConnectionData) GetPodsByLabels

func (p *KubeConnectionData) GetPodsByLabels(
	namespace string,
	labels string,
) ([]v1.Pod, error)

func (*KubeConnectionData) GetPvcsByLabels

func (p *KubeConnectionData) GetPvcsByLabels(
	namespace string,
	labels string,
) ([]v1.PersistentVolumeClaim, error)

type PxPvc

type PxPvc struct {
	Name      string
	Namespace string
	PodNames  []string
	Pvc       *v1.PersistentVolumeClaim
	PxVolume  *api.Volume
	Pods      []v1.Pod
}

func NewPxPvc

func NewPxPvc(pvc *v1.PersistentVolumeClaim) *PxPvc

func (*PxPvc) GetPodNames

func (p *PxPvc) GetPodNames() []string

func (*PxPvc) GetVolume

func (p *PxPvc) GetVolume() *api.Volume

func (*PxPvc) SetPods

func (p *PxPvc) SetPods(pods []v1.Pod) bool

SetPods return true if found

func (*PxPvc) SetVolume

func (p *PxPvc) SetVolume(responses []*api.SdkVolumeInspectResponse) bool

SetVolume return true if found