iuf

Documentation

Overview

* * MIT License * * (C) Copyright 2022 Hewlett Packard Enterprise Development LP * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. *

* * MIT License * * (C) Copyright 2022 Hewlett Packard Enterprise Development LP * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. *

* * MIT License * * (C) Copyright 2022 Hewlett Packard Enterprise Development LP * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. *

* * MIT License * * (C) Copyright 2022 Hewlett Packard Enterprise Development LP * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. *

* * MIT License * * (C) Copyright 2022 Hewlett Packard Enterprise Development LP * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. *

Index

• func Validate(file_contents []byte) error
• func ValidateFile(file_path string) error
• type Activity
• type ActivityState
• type CreateActivityRequest
• type History
• type HistoryActionRequest
• type InputParameters
• type PatchActivityRequest
• type Product
• type ReplaceHistoryCommentRequest
• type Session
• type SessionState
• type SessionWorkflow

Functions

func Validate

func Validate(file_contents []byte) error

func ValidateFile

func ValidateFile(file_path string) error

Types

type Activity

type Activity struct {
	Name             string                 `json:"name"`                                                                                      // Name of activity
	InputParameters  InputParameters        `json:"input_parameters" binding:"required"`                                                       // Input parameters by admin
	OperationOutputs map[string]interface{} `json:"operation_outputs" binding:"required"`                                                      // Operation outputs from argo
	Products         []Product              `json:"products" binding:"required"`                                                               // List of products included in an activity
	ActivityState    ActivityState          `json:"activity_state" binding:"required" enums:"paused,in_progress,debug,blocked,wait_for_admin"` // State of activity

} // @name Activity

Activity

type ActivityState

type ActivityState string

const (
	ActivityStateInProgress   ActivityState = "in_progress"
	ActivityStatePaused       ActivityState = "paused"
	ActivityStateDebug        ActivityState = "debug"
	ActivityStateBlocked      ActivityState = "blocked"
	ActivityStateWaitForAdmin ActivityState = "wait_for_admin"
)

type CreateActivityRequest

type CreateActivityRequest struct {
	Name            string          `json:"name" binding:"required"` // Name of activity
	InputParameters InputParameters `json:"input_parameters"`        // Input parameters by admin
	ActivityState   ActivityState   `json:"activity_state" swaggerignore:"true"`

} // @name Activity.CreateActivityRequest

type History

type History struct {
	State       ActivityState `json:"state" enums:"paused,in_progress,debug,completed"` // State of Activity
	SessionName string        `json:"session_name"`                                     // Name of the session
	StartTime   int32         `json:"start_time"`                                       // Epoch timestamp
	Comment     string        `json:"comment"`                                          // Comment

} // @name History

History

type HistoryActionRequest

type HistoryActionRequest struct {
	StartTime int32  `json:"start_time" validate:"optional"` // Epoch timestamp
	Comment   string `json:"comment" validate:"optional"`    // Comment

} // @name History.HistoryActionRequest

type InputParameters

type InputParameters struct {
	MediaDir                 string   `json:"media_dir"`                  // Location of media
	SiteParameters           string   `json:"site_parameters"`            // The inline contents of the site_parameters.yaml file.
	LimitNodes               []string `json:"limit_nodes"`                // Each item is the xname of a node
	BootprepConfigManaged    []string `json:"bootprep_config_managed"`    // Each item is a path of the bootprep files
	BootprepConfigManagement []string `json:"bootprep_config_management"` // Each item is a path of the bootprep files
	Stages                   []string `json:"stages"`                     // Stages to execute
	Force                    bool     `json:"force"`                      // Force re-execution of stage operations

} // @name InputParameters

type PatchActivityRequest

type PatchActivityRequest struct {
	InputParameters InputParameters `json:"input_parameters" binding:"required"`

} // @name Activity.PatchActivityRequest

type Product

type Product struct {
	// The name of the product
	Name string `json:"name" validate:"required"`
	// The version of the product.
	Version string `json:"version" validate:"required"`
	// The original location of the extracted tar in on the physical storage.
	OriginalLocation string `json:"original_location"  validate:"required"`
	// The flag indicates md5 of a product tarball file has been validated
	Validated bool `json:"validated"  validate:"required"`

} // @name Product

type ReplaceHistoryCommentRequest

type ReplaceHistoryCommentRequest struct {
	Comment string `json:"comment"` // Comment

} // @name History.ReplaceHistoryCommentRequest

type Session

type Session struct {
	InputParameters InputParameters   `json:"input_parameters"`
	CurrentState    SessionState      `json:"current_state" enums:"paused,in_progress,debug,completed"`
	CurrentStage    string            `json:"stage"`
	Workflows       []SessionWorkflow `json:"workflows"`
	Products        []Product         `json:"products" validate:"required"`

} // @name Session

IufSession

type SessionState

type SessionState string

const (
	SessionStateInProgress SessionState = "in_progress"
	SessionStatePaused     SessionState = "paused"
	SessionStateDebug      SessionState = "debug"
	SessionStateCompleted  SessionState = "completed"
)

type SessionWorkflow

type SessionWorkflow struct {
	Id  string `json:"id"`  // id of argo workflow
	Url string `json:"url"` // url to the argo workflow

} // @name Session.Workflow