ConfigStorage#
- class phalanx.storage.config.ConfigStorage(path)#
Bases:
object
Analyze Phalanx configuration and convert it to models.
- Parameters:
path (
Path
) – Path to the root of the Phalanx configuration.
Methods Summary
add_application_setting
(application, setting)Add the setting for a new application to the environments chart.
get_application_chart_path
(application)Determine the path to an application Helm chart.
get_starter_path
(starter)Determine the path to a Helm starter template.
load_environment
(environment_name)Load the configuration of a Phalanx environment from disk.
load_environment_config
(environment_name)Load the top-level configuration for a Phalanx environment.
Load the full Phalanx configuration.
write_application_template
(name, template)Write the Argo CD application template for a new application.
Methods Documentation
- add_application_setting(application, setting)#
Add the setting for a new application to the environments chart.
Adds a block for a new application to
values.yaml
in the environments directory in the correct alphabetical location.
- get_application_chart_path(application)#
Determine the path to an application Helm chart.
The application and path may not exist, since this function is also used to generate the path to newly-created applications.
- Parameters:
application (
str
) – Name of the application.- Returns:
Path to that application’s chart.
- Return type:
- get_starter_path(starter)#
Determine the path to a Helm starter template.
- Parameters:
starter (
HelmStarter
) – Name of the Helm starter template.- Returns:
Path to that Helm starter template.
- Return type:
- load_environment(environment_name)#
Load the configuration of a Phalanx environment from disk.
- Parameters:
environment_name (
str
) – Name of the environment.- Returns:
Environment configuration.
- Return type:
- Raises:
UnknownEnvironmentError – Raised if the named environment has no configuration.
- load_environment_config(environment_name)#
Load the top-level configuration for a Phalanx environment.
Unlike load_environment, this only loads the top-level environment configuration and its list of enabled applications. It does not load the configuration for all of the applications themselves.
- Parameters:
environment_name (
str
) – Name of the environent.- Returns:
Loaded environment.
- Return type:
- Raises:
InvalidEnvironmentConfigError – Raised if the configuration for an environment is invalid.
UnknownEnvironmentError – Raised if the named environment has no configuration.
- load_phalanx_config()#
Load the full Phalanx configuration.
Used primarily for generating docuemntation.
- Returns:
Phalanx configuration for all environments.
- Return type:
- Raises:
InvalidApplicationConfigError – Raised if the namespace for the application could not be found.
InvalidEnvironmentConfigError – Raised if the configuration for an environment is invalid.
- write_application_template(name, template)#
Write the Argo CD application template for a new application.
- Parameters:
- Raises:
ApplicationExistsError – Raised if the application being created already exists.
- Return type: