Categorygithub.com/ekara-platform/model
modulepackage
1.0.0
Repository: https://github.com/ekara-platform/model.git
Documentation: pkg.go.dev

# README

Build Status Go Report Card

Ekara platform model

Go library containing the Ekara Platform Model along with the YAML descriptor parser/validator.

Godoc here : https://godoc.org/github.com/ekara-platform/model

# Packages

No description provided by the author

# Functions

ApplyTemplate apply the parameters on the template represented by the descriptor content.
ChainDescribable merges the types and names of several Describables.
CreateBase a new Base for the provided url, if the url is not specified then it will be defaulted to DefaultComponentBase.
CreateComponent creates a new component Parameters id: the id of the component repo: the repository where to fetch the component.
CreateComponentBase returns a new Base for the url specified in the Ekara section of the provided environment/descriptor, if the url is not defined then it will be defaulted to DefaultComponentBase.
CreateEnvironment creates a new environment based on the provided yamlThe older passed as parameter y the name of the component holding the ekara.yaml on which the environment has been built.
CreateOrphans return an initialized manager.
CreateParameters builds Parameters from the specified map.
CreateParent creates the parent.
CreateReferencedComponents return an initialized manager.
CreateRepository creates a repository Parameters base: the base URL where to look for the component repo: the repository Url where to fetch the component ref: the ref to fetch, if the ref is not specified then the default branch will be fetched descriptor: the name of the descriptor, if not specified then it will be defaulted.
CreateTBaseForBase returns an holder of Base implementing TBase.
CreateTComponentForComponent returns an holder of Component implementing TComponent.
CreateTComponentForParent returns an holder of Parent implementing TComponent.
CreateTCopyForCopy returns an holder of Copy implementing TCopy.
CreateTDependenciesForDependencies returns an holder of Dependencies implementing TDependencies.
CreateTemplateContext Returns a template context.
CreateTEnvironmentForEnvironment returns an holder of Environment implementing TEnvironment.
CreateTEnvironmentHooksForEnvironmentHooks returns an holder of EnvironmentHooks implementing TEnvironmentHooks.
CreateTHookForHook returns an holder of Hook implementing THook.
CreateTNodeHookForNodeHook returns an holder of NodeHook implementing TNodeHook.
CreateTNodeSetForNodeSet returns an holder of NodeSet implementing TNodeSet.
CreateTOrchestratorForOrchestrator returns an holder of Orchestrator implementing TOrchestrator.
CreateTOrchestratorRefForOrchestratorRef returns an holder of OrchestratorRef implementing TOrchestratorRef.
CreateTPlatformForPlatform returns an holder of Platform implementing TPlatform.
CreateTProviderForProvider returns an holder of Provider implementing TProvider.
CreateTProviderRefForProviderRef returns an holder of ProviderRef implementing TProviderRef.
CreateTProxyForProxy returns an holder of Proxy implementing TProxy.
CreateTRepositoryForRepository returns an holder of Repository implementing TRepository.
CreateTStackForStack returns an holder of Stack implementing TStack.
CreateTStackHooksForStackHook returns an holder of StackHook implementing TStackHooks.
CreateTStackRefForStackRef returns an holder of StackRef implementing TStackRef.
CreateTTaskForTask returns an holder of Task implementing TTask.
CreateTTaskHooksForTaskHook returns an holder of TaskHook implementing TTaskHooks.
CreateTTaskRefForTaskRef returns an holder of TaskRef implementing TTaskRef.
CreateTURLForEkURL returns an holder of EkURL implementing TURL.
CreateUrl creates an Ekara url for the given path.
CreateUsedReferences returns an initialized manager.
DirExist returns true if a directory corresponding to the given path exixts.
FileExist returns true if a file corresponding to the given path exixts.
GetCurrentDirectoryURL return the working directory as an url.
InitEnvironment creates an new Environment.
ParseParameters parses a yaml file into a Parameters.
ParseYamlDescriptor returns an environment based on parsing of the descriptor located at the provided URL.
ParseYamlDescriptorReferences returns an the references, declared and used, into the environment based on parsing of the descriptor located at the provided URL.

# Constants

DefaultComponentBase specifies the default base URL where to look for a component For example if component is defined like this: components: aws: repository: ekara-platform/aws-provider version: 1.2.3 We will assume that this is a Git component located in: https://github.com/: ekara-platform/aws-provider .
DefaultDescriptorName specifies the default name of the environment descriptor When the environment descriptor is not specified, for example into a use component then we will look for a default descriptor name "ekara.yaml".
EkaraComponentId The component identifier for the ekara parent.
Error allows to mark validation error as Error.
GenericNodeSetName is the name of the generic node set The generic node set is intended to be used for sharing common content, example: parameter, environment variables..., with all others node sets within the whole descriptor.
GitExtension represents the extension of the GIT repository extension.
GitScm type of GIT source control management system.
HookAfter Hook located after a task.
HookBefore Hook located before a task.
MainComponentId The component identifier for the main descriptor.
SchemeFile scheme for a file.
SchemeGits scheme for Git.
SchemeHttp scheme for http.
SchemeHttps scheme for https.
SchemeSvn scheme for svn.
SchemeUnknown scheme is unknown.
SvnScm type of SVN source control management system.
UnknownScm represents an unknown source control management system.
Warning allows to mark validation error as Warning.

# Variables

ErrorOnEmptyOrInvalid allows to validate interfaces matching the following content: The created validation errors will be errors.
ErrorOnInvalid allows to validate interfaces matching the following content: The created validation errors will be errors.
IsAValidQualifier is the regular expression used to validate the qualified name of an environment The qualified name is the concatenation if the environment name and its qualifier separated by a "_" The name and the qualifier can contain only alphanumerical characters.
WarningOnEmptyOrInvalid allows to validate interfaces matching the following content: The created validation errors will be warnings.

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Platform the platform used to build an environment.
No description provided by the author
No description provided by the author
Proxy represents the proxy definition.
QualifiedName The Qualified name of an environment.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TBaseOnBaseHolder is the struct containing the Base in order to implement TBase.
TComponentOnComponentHolder is the struct containing the Component in order to implement TComponent.
TComponentOnParentHolder is the struct containing the Parent in order to implement TComponent.
TCopyOnCopyHolder is the struct containing the Copy in order to implement TCopy.
TDependenciesOnDependenciesHolder is the struct containing the Dependencies in order to implement TDependencies.
No description provided by the author
TEnvironmentHooksOnEnvironmentHooksHolder is the struct containing the EnvironmentHooks in order to implement TEnvironmentHooks.
TEnvironmentOnEnvironmentHolder is the struct containing the Environment in order to implement TEnvironment.
THookOnHookHolder is the struct containing the Hook in order to implement THook.
TNodeHookOnNodeHookHolder is the struct containing the NodeHook in order to implement TNodeHook.
TNodeSetOnNodeSetHolder is the struct containing the NodeSet in order to implement TNodeSet.
TOrchestratorOnOrchestratorHolder is the struct containing the Orchestrator in order to implement TOrchestrator.
TOrchestratorRefOnOrchestratorRefHolder is the struct containing the OrchestratorRef in order to implement TOrchestratorRef.
TPlatformOnPlatformHolder is the struct containing the Platform in order to implement TPlatform.
TProviderOnProviderHolder is the struct containing the Provider in order to implement TProvider.
TProviderRefOnProviderRefHolder is the struct containing the ProviderRef in order to implement TProviderRef.
TProxyOnProxyHolder is the struct containing the Proxy in order to implement TProxy.
TRepositoryOnRepositoryHolder is the struct containing the Repository in order to implement TRepository.
TStackHooksOnStackHookHolder is the struct containing the StackHook in order to implement TStackHooks.
TStackOnStackHolder is the struct containing the Stack in order to implement TStack.
TStackRefOnStackRefHolder is the struct containing the StackRef in order to implement TStackRef.
TTaskHooksOnTaskHookHolder is the struct containing the TaskHook in order to implement TTaskHooks.
TTaskOnTaskHolder is the struct containing the Task in order to implement TTask.
TTaskRefOnTaskRefHolder is the struct containing the TaskRef in order to implement TTaskRef.
TURLOnEkURLHolder is the struct containing the EkURL in order to implement TURL.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

No description provided by the author
No description provided by the author
No description provided by the author
TBase is a read only base location.
TComponent is a read only component.
TCopy is a read only representation of files to be copied.
TDependencies is a read only list of stack dependencies.
TEnvironment is a read only environment.
TEnvironmentHooks is a read only representation of the hooks associated to an environment.
THook is a read only hooks.
TNodeHook is a read only representation of the hooks associated to a node.
TNodeSet is a read only node set.
TOrchestrator is a read only orchestrator.
TOrchestratorRef is a read only reference on the orchestrator.
TPlatform is a read only platform.
TProvider is a read only provider.
TProviderRef is a read only reference on a provider.
TProxy is a read only proxy configuration.
TRepository is a read only repository.
TStack is a read only stack.
TStackHooks is a read only representation of the hooks associated to a stack.
TStackRef is a read only reference on a stack.
TTask is a read only task.
TTaskHooks is a read only representation of the hooks associated to a task.
TTaskRef is a read only reference on a task.
TURL is a read only ekara url.

# Type aliases

EnvVars Represents environment variable.
No description provided by the author
No description provided by the author
Labels represents used defined labels which will be placed on the created environmentmachines and also on the nodes for Docker.
No description provided by the author
Parameters represents the parameters coming from a descriptor.
Parent Represents the parent used to run Ekara.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author