cli

Documentation

Overview

DigitalRebar Provision CLI provides the core parts of the CLI. This CLI uses an access core based upon a set of generated files from the generated swagger.json file.

Copyright © 2020 RackN <support@rackn.com>

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

• Variables
• func AddDirToZip(zipWriter *zip.Writer, dirname string) error
• func AddFileToZip(zipWriter *zip.Writer, filename string) error
• func NewApp() *cobra.Command
• func NewBasicKeyRequest() *basicKeyReq
• func PatchWithFunction(key string, op *ops, fn func(models.Model) (models.Model, bool)) error
• func PatchWithString(key, js string, op *ops) error
• func ResetDefaults()
• type DocData
  • func (dd *DocData) LengthString(str, pat string) string
• type LabDocData
  • func (dd *LabDocData) Encapsulate(str, first, pat string) string
  • func (dd *LabDocData) LengthString(str, pat string) string
  • func (dd *LabDocData) MarkdownToRst(data string) string
  • func (dd *LabDocData) RenderSection(tmplFile string, ls *models.LabSection, depth int, tab string) string
  • func (dd *LabDocData) ToRef(names ...string) string
• type Service
• type Services
• type Warning

Variables

var (
	// ActuallyPowerThings is a boolean to use in testing to keep from power off the test machine
	ActuallyPowerThings = true
	// DefaultStateLoc is the default location to save agent state
	DefaultStateLoc string
)

var (

	// Session is the global client access session
	Session *api.Client
)

Functions

func AddDirToZip

func AddDirToZip(zipWriter *zip.Writer, dirname string) error

given a top level dir this will walk it adding files and folders. to the archive

func AddFileToZip

func AddFileToZip(zipWriter *zip.Writer, filename string) error

adds an individual file to the archive

func NewApp

func NewApp() *cobra.Command

NewApp is the app start function

func NewBasicKeyRequest

func NewBasicKeyRequest() *basicKeyReq

NewBasicKeyRequest returns a default BasicKeyRequest.

func PatchWithFunction

func PatchWithFunction(key string, op *ops, fn func(models.Model) (models.Model, bool)) error

The input function takes the object and returns the modified object and if the object changed.

func PatchWithString

func PatchWithString(key, js string, op *ops) error

func ResetDefaults

func ResetDefaults()

Types

type DocData

type DocData struct {
	Name          string
	RefName       string
	DisplayName   string
	Full          string
	Version       string
	Documentation string
	Objects       [][]models.Docer
}

func (*DocData) LengthString

func (dd *DocData) LengthString(str, pat string) string

type LabDocData

type LabDocData struct {
	Lab        *models.Lab
	LabSection *models.LabSection
	Depth      int
	InTab      bool
	VideoTag   string
	VideoTime  string
}

func (*LabDocData) Encapsulate

func (dd *LabDocData) Encapsulate(str, first, pat string) string

func (*LabDocData) LengthString

func (dd *LabDocData) LengthString(str, pat string) string

func (*LabDocData) MarkdownToRst

func (dd *LabDocData) MarkdownToRst(data string) string

func (*LabDocData) RenderSection

func (dd *LabDocData) RenderSection(tmplFile string, ls *models.LabSection, depth int, tab string) string

func (*LabDocData) ToRef

func (dd *LabDocData) ToRef(names ...string) string

type Service

type Service struct {
	Service string
	Port    string
}

type Services

type Services struct {
	Services []Service
	Warnings []Warning
}

type Warning

type Warning struct {
	Service string
	Port    string
	Warn    string
}