cubkit

package

v0.1.2 Latest Latest Go to latest Published: Feb 18, 2026 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/confighub/sdk

Links

Open Source Insights

Documentation ¶

Overview ¶

Package cubkit is used to interpret ConfigHub/YAML configuration units.

Constants ¶

View Source

const (
	ResourceTypeNoEntityType = api.ResourceType("NoEntityType")
	ResourceNameNoName       = api.ResourceName("NoName")
	EntityTypePath           = api.ResolvedPath("EntityType")
	EntityNamePath           = api.ResolvedPath("Slug")
	EntityScopePath          = api.ResolvedPath("SpaceSlug")
)

Variables ¶

View Source

var ConfigHubNonSpaceScopedEntityTypes = map[api.ResourceType]bool{
	api.ResourceType("Organization"):       true,
	api.ResourceType("OrganizationMember"): true,
	api.ResourceType("User"):               true,
	api.ResourceType("Space"):              true,
}

View Source

var ConfigHubResourceProvider = &ConfigHubResourceProviderType{}

ConfigHubResourceProvider implements the ResourceProvider interface for ConfigHub/YAML.

Functions ¶

This section is empty.

Types ¶

type ConfigHubResourceProviderType ¶

type ConfigHubResourceProviderType struct{}

func (*ConfigHubResourceProviderType) ContextPath ¶

func (*ConfigHubResourceProviderType) ContextPath(contextField string) string

func (*ConfigHubResourceProviderType) DataType ¶

func (*ConfigHubResourceProviderType) DataType() api.DataType

func (*ConfigHubResourceProviderType) DefaultResourceCategory ¶

func (*ConfigHubResourceProviderType) DefaultResourceCategory() api.ResourceCategory

DefaultResourceCategory returns the default resource category to asssume, which is AppConfig in this case.

func (*ConfigHubResourceProviderType) GetPathRegistry ¶

func (*ConfigHubResourceProviderType) GetPathRegistry() api.AttributeNameToResourceTypeToPathToVisitorInfoType

func (*ConfigHubResourceProviderType) NameSeparator ¶

func (*ConfigHubResourceProviderType) NameSeparator() string

func (*ConfigHubResourceProviderType) NativeToYAML ¶

func (*ConfigHubResourceProviderType) NativeToYAML(data []byte) ([]byte, error)

func (*ConfigHubResourceProviderType) NormalizeName ¶

func (*ConfigHubResourceProviderType) NormalizeName(name string) string

func (*ConfigHubResourceProviderType) ParseResourceName ¶

func (*ConfigHubResourceProviderType) ParseResourceName(resourceName api.ResourceName) (string, string)

func (*ConfigHubResourceProviderType) RemoveScopeFromResourceName ¶

func (c *ConfigHubResourceProviderType) RemoveScopeFromResourceName(resourceName api.ResourceName) api.ResourceName

func (*ConfigHubResourceProviderType) ResourceAndCategoryTypeMaps ¶

func (*ConfigHubResourceProviderType) ResourceAndCategoryTypeMaps(docs gaby.Container) (resourceMap yamlkit.ResourceNameToCategoryTypesMap, categoryTypeMap yamlkit.ResourceCategoryTypeToNamesMap, err error)

ResourceAndCategoryTypeMaps returns maps of all resources in the provided list of parsed YAML documents, from from names to categories+types and categories+types to names.

func (*ConfigHubResourceProviderType) ResourceCategoryGetter ¶

func (*ConfigHubResourceProviderType) ResourceCategoryGetter(doc *gaby.YamlDoc) (api.ResourceCategory, error)

ResourceCategoryGetter just returns ResourceCategoryResource for ConfigHub/YAML documents.

func (*ConfigHubResourceProviderType) ResourceNameGetter ¶

func (*ConfigHubResourceProviderType) ResourceNameGetter(doc *gaby.YamlDoc) (api.ResourceName, error)

ResourceNameGetter extracts the property Slug, and returns NoName if not present.

func (*ConfigHubResourceProviderType) ResourceTypeGetter ¶

func (*ConfigHubResourceProviderType) ResourceTypeGetter(doc *gaby.YamlDoc) (api.ResourceType, error)

ResourceTypeGetter extracts the property EntityType, and returns NoEntityType if not present.

func (*ConfigHubResourceProviderType) ResourceTypesAreSimilar ¶

func (*ConfigHubResourceProviderType) ResourceTypesAreSimilar(resourceTypeA, resourceTypeB api.ResourceType) bool

TODO: Trigger and Invocation?

func (*ConfigHubResourceProviderType) ScopelessResourceNamePath ¶

func (*ConfigHubResourceProviderType) ScopelessResourceNamePath() api.ResolvedPath

func (*ConfigHubResourceProviderType) SetResourceName ¶

func (*ConfigHubResourceProviderType) SetResourceName(doc *gaby.YamlDoc, name string) error

func (*ConfigHubResourceProviderType) TypeDescription ¶

func (*ConfigHubResourceProviderType) TypeDescription() string

func (*ConfigHubResourceProviderType) YAMLToNative ¶

func (*ConfigHubResourceProviderType) YAMLToNative(yamlData []byte) ([]byte, error)

Source Files ¶

View all Source files

cubkit.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL