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.

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 KubeConnectDefault() (clientcmd.ClientConfig, *kubernetes.Clientset, error)
• func StartTunnel() error
• func StopTunnel()
• type COps
  • func NewCOps() (COps, error)
• type COpsLogOptions
• type ContainerInfo
• type KubectlPortForwarder
  • func (p *KubectlPortForwarder) Endpoint() string
  • func (p *KubectlPortForwarder) Start() error
  • func (p *KubectlPortForwarder) Stop() error
• type PortForwarder
  • func NewKubectlPortForwarder(kubeconfig string) PortForwarder
• 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(vols []*api.Volume) bool

Constants

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

Variables

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

Functions

func KubeConnectDefault

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

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

func StartTunnel

func StartTunnel() error

StartTunnel starts the global tunnel to the Portworx endpoint through the Kubernetes service

func StopTunnel

func StopTunnel()

StopTunnel stops the global tunnel to the Portworx endpoint through the Kubernetes service

Types

type COps

type COps interface {
	// Close close the connection
	Close()
	// GetNamespace returns the namespace requested
	GetNamespace() (string, error)
	// 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() (COps, error)

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 KubectlPortForwarder

type KubectlPortForwarder struct {
	// contains filtered or unexported fields
}

KubectlPortForwarder object

func (*KubectlPortForwarder) Endpoint

func (p *KubectlPortForwarder) Endpoint() string

Endpoint returns the gRPC endpoint to the SDK

func (*KubectlPortForwarder) Start

func (p *KubectlPortForwarder) Start() error

Start creates the portforward using kubectl

func (*KubectlPortForwarder) Stop

func (p *KubectlPortForwarder) Stop() error

Stop ends the session

type PortForwarder

type PortForwarder interface {
	Endpoint() string
	Start() error
	Stop() error
}

PortForwarder provides a way to forward a local port to Portworx endpoint

func NewKubectlPortForwarder

func NewKubectlPortForwarder(kubeconfig string) PortForwarder

NewKubectlPortForwarder forwards a local port to the Portworx gRPC SDK endpoint through the Kubernetes API server using kubectl If kubeconfig is not provided, then kubectl will use the default kubeconfig

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(vols []*api.Volume) bool

SetVolume return true if found