Package io.wcm.devops.conga.model.environment

Class Environment

  • All Implemented Interfaces:
    Configurable, Serializable
    public final class Environment
extends AbstractConfigurable
    Defines an environment with a set of nodes and configuration. The filename of the environment YAML file is the environment name, it's not included in the model.
    See Also:
    Serialized Form

    • Constructor Detail

      • Environment

        public Environment()

    • Method Detail

      • getNodes

        public List<Node> getNodes()
        Defines nodes for the environment.
        Returns:
        List of nodes

      • setNodes

        public void setNodes​(List<Node> nodes)

      • getRoleConfig

        public List<RoleConfig> getRoleConfig()
        Defines role-specific configuration. In this section it is possible to define configuration parameters that affect each node that has this role defined.
        Returns:
        Configurations per role

      • setRoleConfig

        public void setRoleConfig​(List<RoleConfig> roleConfig)

      • getTenants

        public List<Tenant> getTenants()
        Defines a list of tenants for configuration files that have tenant-specific system configurations. E.g. vhosts files for Apache Webserver.
        Returns:
        List of tenants

      • setTenants

        public void setTenants​(List<Tenant> tenants)

      • getDependencies

        public List<String> getDependencies()
        Defines a list of file URLs pointing to JAR files with CONGA definitions that contain dependencies (e.g. roles) to be used in this environment.
        Returns:
        List of dependencies

      • setDependencies

        public void setDependencies​(List<String> dependencies)

      • getPluginConfig

        public Map<String,​Map<String,​Object>> getPluginConfig()
        Defines a map of configuration parameters for CONGA plugins.

        The outer map contains the plugin names as keys, and the configuration for this plugin as value. The inner map contains the key/value pairs for the plugin configuration.

        The configurations are merged with the configuration parameters defined in the POM.

        Returns:
        Plugin configuration parameter map

      • setPluginConfig

        public void setPluginConfig​(Map<String,​Map<String,​Object>> pluginConfig)
        Parameters:
        pluginConfig - Plugin configuration parameter map