package
21.11.1
Repository: https://github.com/cs-si/safescale.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

No description provided by the author
CheckMetadataVersion checks if the content of /version in metadata bucket is equal to MetadataVersion.
CurrentTenant returns the tenant used for commands or, if not set, set the tenant to use if it is the only one registered.
ExtractFeatureParameters convert a slice of string in format a=b into a map index on 'a' with value 'b'.
No description provided by the author
FreeCIDRForSingleHost frees the CIDR index inside the Network 'Network'.
ListSubnets returns a list of available subnets.
LoadBucket instantiates a bucket struct and fill it with Provider metadata of Object Storage ObjectStorageBucket.
LoadCluster loads cluster information from metadata.
LoadFeatureFile searches for a spec file named 'name' and initializes a new FeatureFile object with its content 'xerr' may contain: - nil: everything worked as expected - fail.ErrNotFound: no FeatureFile is found with the name - fail.ErrSyntax: FeatureFile contains syntax error.
LoadHost ...
LoadNetwork loads the metadata of a subnet if 'options' contains WithReloadOption, the instance is refreshed from metadata.
LoadSecurityGroup ...
LoadShare returns the name of the host owing the Share 'ref', read from Object Storage logic: try to read until success.
LoadSubnet loads the metadata of a Subnet.
LoadVolume loads the metadata of a subnet.
NewAptInstaller creates a new instance of Installer using script.
NewBucket instantiates bucket struct.
NewCluster is the constructor of resources.Cluster struct.
NewConditionedFeatureParameter creates an instance of ConditionedFeatureParameter from FeatureParameter and sets the current value.
NewCore creates an instance of MetadataCore.
NewDnfInstaller creates a new instance of Installer using script.
NewEmbeddedFeature searches for an embedded featured named 'name' and initializes a new Feature object with its content.
NewFeature searches for a spec file name 'name' and initializes a new Feature object with its content error contains : - fail.ErrNotFound if no Feature is found by its name - fail.ErrSyntax if Feature found contains syntax error.
NewFeatureParameter initiales an new instance of FeatureParameter.
NewHost ...
NewKongController creates a controller for Kong.
NewMetadataFolder creates a new Metadata MetadataFolder object, ready to help access the metadata inside it.
NewNetwork creates an instance of Networking.
NewSecurityGroup ...
NewShare creates an instance of Share.
NewSubnet creates an instance of Subnet used as resources.Subnet.
NewVolume creates an instance of Volume.
NewYumInstaller creates a new instance of Installer using script.
ReserveCIDRForSingleHost returns the first available CIDR and its index inside the Network 'network'.
SetCurrentTenant sets the tenant to use for upcoming commands.
StartFeatureFileWatcher inits the watcher of Feature File changes.

# Constants

FirstMetadataVersion corresponds to the first metadata format version.
MinimumMetadataVersion defines the version of the metadata recognized by the release Must be incremented each time a new release requires upgrade of metadata (hopefully not for all new releases) By convention, it corresponds to the SafeScale release that introduced the new format.
No description provided by the author
MustUpgradeMessage = "the current version of SafeScale binaries cannot use safely the current tenant metadata; you should consider upgrading the metadata using the command 'safescale tenant metadata upgrade %s'.
NOTFOUND Not found.
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
Trace contains what to trace during debug log.
WithoutReloadOption is used as option to LoadXXX() to disable reloading from metadata and/or local instance caching (that may lead to deadlock sometimes).
WithReloadOption is used as option to LoadXXX() to enable reloading from metadata.

# Structs

Cluster is the implementation of resources.Cluster interface.
ConditionedFeatureParameter describes a Feature prepared for use on a Target.
Feature contains the information about a FeatureFile to be installed.
FeatureFile contains the information about an installable Feature.
FeatureParameter describes a Feature parameter as defined by Feature file content.
Host ..
Item is a helper struct to ease the copy of local files to remote.
KongController allows to control Kong, installed on a host.
MetadataCore contains the core functions of a persistent object.
MetadataFolder describes a metadata MetadataFolder.
Network links Object Storage MetadataFolder and Networking.
RemoteFilesHandler handles the copy of files and cleanup.
SecurityGroup ..
Share contains information to maintain in Object Storage a list of shared folders.
ShareIdentity contains information about a Share.
Subnet links Object Storage MetadataFolder and Subnet.
Tenant structure to handle name and Service for a tenant.

# Interfaces

Installer defines the API of an Installer.

# Type aliases

No description provided by the author