Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( DefaultRepo = "sirosfoundation/compliance" DefaultURL = "https://compliance.siros.org" DefaultName = "Compliance Dashboard" )
Defaults used when no .grc.yaml exists.
Functions ¶
This section is empty.
Types ¶
type CatalogConfig ¶ added in v0.2.0
type CatalogConfig struct {
Dir string `yaml:"dir"`
Subdirs []string `yaml:"subdirs"`
FrameworksDir string `yaml:"frameworks_subdir"`
}
CatalogConfig holds catalog-specific settings.
type Config ¶
type Config struct {
Root string
CatalogDir string
MappingsDir string
AuditsDir string
SiteDir string
OSCALDir string
Project ProjectConfig
Frameworks []FrameworkConfig
CatalogSubdirs []string
FrameworksSubdir string
}
Config holds the resolved runtime configuration.
type DirConfig ¶ added in v0.2.0
type DirConfig struct {
Dir string `yaml:"dir"`
}
DirConfig holds directory layout settings.
type FrameworkConfig ¶ added in v0.2.0
type FrameworkConfig struct {
ID string `yaml:"id"`
Name string `yaml:"name"`
CatalogFile string `yaml:"catalog_file"`
MappingFile string `yaml:"mapping_file"`
SidebarPosition int `yaml:"sidebar_position"`
}
FrameworkConfig describes one compliance framework to load and render.
type GRCFile ¶ added in v0.2.0
type GRCFile struct {
Project ProjectConfig `yaml:"project"`
Catalog CatalogConfig `yaml:"catalog"`
Mappings DirConfig `yaml:"mappings"`
Audits DirConfig `yaml:"audits"`
Site DirConfig `yaml:"site"`
OSCAL DirConfig `yaml:"oscal"`
Frameworks []FrameworkConfig `yaml:"frameworks"`
}
GRCFile is the top-level .grc.yaml file structure.
type ProjectConfig ¶ added in v0.2.0
type ProjectConfig struct {
Name string `yaml:"name"`
Repo string `yaml:"repo"`
URL string `yaml:"url"`
}
ProjectConfig holds project-level identity settings.
Source Files
Click to show internal directories.
Click to hide internal directories.