volume

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.

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
• func CreateAddCommand(c *cobra.Command)
• func DeleteAddCommand(cmd *cobra.Command)
• func DescribeAddCommand(cmd *cobra.Command)
• func GetAddCommand(cmd *cobra.Command)
• func NewVolumeGetFormatter(cliOps cliops.CliOps) *volumeGetFormatter
• func NewVolumeStatsGetFormatter(cliOps cliops.CliOps, vsd VolumeStats) *volumeStatsGetFormatter
• func PatchAddCommand(cmd *cobra.Command)
• func VolumeAddCommand(cmd *cobra.Command)
• func VolumeCloneAddCommand(cmd *cobra.Command)
• func VolumeSnapshotAddCommand(cmd *cobra.Command)
• func VolumeStatsAddCommand(cmd *cobra.Command)
• type ColNum
• type VolumeDescribeFormatter
  • func NewVolumeDescribeFormatter(cliOps cliops.CliOps) *VolumeDescribeFormatter
  • func (p *VolumeDescribeFormatter) AddVolumeDetails(v *api.Volume, t *tabby.Tabby, usedPods []v1.Pod) error
  • func (p *VolumeDescribeFormatter) DefaultFormat() (string, error)
• type VolumeStats
  • func NewVolumeStats(cliOps cliops.CliOps, volumes portworx.Volumes) VolumeStats

Constants

const (
	DEFAULT_SORT_COLUMN = WRITE_TPUT
)

Functions

func CreateAddCommand

func CreateAddCommand(c *cobra.Command)

func DeleteAddCommand

func DeleteAddCommand(cmd *cobra.Command)

func DescribeAddCommand

func DescribeAddCommand(cmd *cobra.Command)

func GetAddCommand

func GetAddCommand(cmd *cobra.Command)

func NewVolumeGetFormatter

func NewVolumeGetFormatter(cliOps cliops.CliOps) *volumeGetFormatter

func NewVolumeStatsGetFormatter

func NewVolumeStatsGetFormatter(
	cliOps cliops.CliOps,
	vsd VolumeStats,
) *volumeStatsGetFormatter

func PatchAddCommand

func PatchAddCommand(cmd *cobra.Command)

func VolumeAddCommand

func VolumeAddCommand(cmd *cobra.Command)

func VolumeCloneAddCommand

func VolumeCloneAddCommand(cmd *cobra.Command)

func VolumeSnapshotAddCommand

func VolumeSnapshotAddCommand(cmd *cobra.Command)

func VolumeStatsAddCommand

func VolumeStatsAddCommand(cmd *cobra.Command)

Types

type ColNum

type ColNum int

const (
	VOL_NAME ColNum = iota
	BYTES_READ
	NUM_READS
	BYTES_WRITTEN
	NUM_WRITES
	IOPS
	IO_PROGRESS
	READ_TPUT
	WRITE_TPUT
	READ_LAT
	WRITE_LAT
)

type VolumeDescribeFormatter

type VolumeDescribeFormatter struct {
	util.BaseFormatOutput
	// contains filtered or unexported fields
}

func NewVolumeDescribeFormatter

func NewVolumeDescribeFormatter(cliOps cliops.CliOps) *VolumeDescribeFormatter

func (*VolumeDescribeFormatter) AddVolumeDetails

func (p *VolumeDescribeFormatter) AddVolumeDetails(
	v *api.Volume,
	t *tabby.Tabby,
	usedPods []v1.Pod,
) error

func (*VolumeDescribeFormatter) DefaultFormat

func (p *VolumeDescribeFormatter) DefaultFormat() (string, error)

DefaultFormat returns the default string representation of the object

type VolumeStats

type VolumeStats interface {
	tui.StatsModel
	// Returns the volumes that this Stats are for
	GetVolumes() ([]*api.Volume, error)
	// Set if we need to show the sort marker in the column header
	ShowSortMarker(fg bool)
}

func NewVolumeStats

func NewVolumeStats(
	cliOps cliops.CliOps,
	volumes portworx.Volumes,
) VolumeStats