psetup

Documentation

Index

• func StepCountFS(fsys fs.FS) (int, error)
• type FrontMatter
• type Step
  • func ParseDocsFS(fsys fs.FS, cfg gconfig.Config, td TemplateData) ([]Step, error)
• type TemplateData

Functions

func StepCountFS

func StepCountFS(fsys fs.FS) (int, error)

StepCountFS reads the filesystem to determine how many steps there are in a provider setup process.

Types

type FrontMatter

type FrontMatter struct {
	Title        string   `yaml:"title"`
	ConfigFields []string `yaml:"configFields"`
}

FrontMatter is the frontmatter in the provider setup docs.

type Step

type Step struct {
	Title        string
	Instructions string
	// ConfigFields which the user needs to enter as part of this step
	ConfigFields []*gconfig.Field
}

func ParseDocsFS

func ParseDocsFS(fsys fs.FS, cfg gconfig.Config, td TemplateData) ([]Step, error)

type TemplateData

type TemplateData struct {
	// AccessHandlerExecutionRoleARN is the ARN of the role that the Access Handler runs as
	AccessHandlerExecutionRoleARN string
}

TemplateData are the particular values to be passed to the instructions template